Fonbnk Docs
  • Intro
  • Integration Guide
  • On-ramp
    • How it works
    • URL Parameters
    • Webhook
  • Off-ramp
    • How it works
    • URL Parameters
    • Webhook
  • Reference
    • Servers
    • Signing requests
    • Endpoints
      • On-ramp
        • Assets
        • Order
        • Orders
        • Price
        • Providers
        • Limits
      • Off-ramp
        • Order
        • Orders
        • Best offer
        • Limits
        • Countries
        • Wallets
        • Validate fields
        • Create order
        • Confirm order
      • Util
        • Check address
        • Assets
      • Kyc
        • State
        • Submit
    • Specification
Powered by GitBook
On this page
  1. Reference
  2. Endpoints
  3. Off-ramp

Validate fields

PreviousWalletsNextCreate order

Validate user required fields

post

The get best offer endpoint returns the required fields that need to be provided by a user. This endpoint allows you to validate the fields provided by a user. Endpoint might return a list of user information that can help a user to verify the correctness of the provided information.

Authorizations
Body
offerIdstringRequired

ID of the offer returned from get best offer endpoint

Responses
200
Validation successful
application/json
post
POST /api/offramp/validate-fields HTTP/1.1
Host: sandbox-api.fonbnk.com
x-client-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "offerId": "65b8c6b8b188250081f30163",
  "requiredFields": {
    "bankCode": "011:02",
    "buyerBankAccountNumber": "3139586782"
  }
}
200

Validation successful

{
  "details": [
    {
      "label": "Bank account holder name",
      "value": "JOHN SMITH"
    }
  ]
}