Requirement

Get field requirements

get

Retrieve the required fields and validation rules for creating a beneficiary.

Authorizations

ServiceKey

X-Service-KeystringRequired

Your Switch API service key. Contact us at [e-mail] to obtain your service key.

Query parameters

directionstring · enumRequired

Transaction direction

Example: OFFRAMPPossible values:

countrystring · enumRequired

ISO 3166-1 alpha-2 country code

Example: NGPossible values:

currencystring · enumOptional

ISO 4217 currency code (optional, defaults to country's default currency)

Example: NGNPossible values:

typestring · enumRequired

Account holder type

Example: INDIVIDUALPossible values:

Responses

200

Successfully retrieved requirements

application/json

400

Bad request - validation error or invalid parameters

application/json

get

/requirement

HTTPcURLJavaScriptPython

GET /requirement?direction=OFFRAMP&country=AD&type=INDIVIDUAL HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "status": 200,
  "message": "Requirement fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "path": "bank.account_number",
      "regex": "^[0-9]+$",
      "example": "0123456789",
      "required": true
    },
    {
      "path": "bank.nuban_code",
      "regex": "^[0-9]+$",
      "example": "0123456789",
      "required": true
    },
    {
      "path": "accountHolder.firstName",
      "regex": "^[0-9a-zA-Z\\s,.#-]{1,15}$",
      "example": "John",
      "required": true
    },
    {
      "path": "accountHolder.lastName",
      "regex": "^[0-9a-zA-Z\\s,.#-]{1,15}$",
      "example": "Doe",
      "required": true
    }
  ]
}