Skip to main content
POST
/
institution
/
lookup
Lookup institution
curl --request POST \
  --url https://api.onswitch.xyz/institution/lookup \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "country": "NG",
  "bank_code": "058",
  "channel": "BANK"
}
'
{
  "success": true,
  "message": "Institution lookup successful",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "code": "058",
    "name": "Guaranty Trust Bank",
    "country": "NG"
  }
}

Authorizations

x-service-key
string
header
required

Service key for API authentication

Body

application/json
country
string
required

ISO 3166-1 alpha-2 country code

Example:

"NG"

bank_code
string

Domestic bank or institution code (e.g. NIBSS bank code)

Example:

"058"

routing_number
string

Bank routing number (e.g. US ACH/Fedwire)

swift_bic
string

SWIFT BIC where applicable

account_number
string

Optional account number for supported account verification flows

channel
enum<string>

Transfer channel context for the lookup

Available options:
BANK,
BLOCKCHAIN,
SWIFT,
SEPA,
SEPA_EUR,
WIRE,
ACH,
DOMESTIC_GBP,
MOBILEMONEY,
ALIPAY,
WECHATPAY

Response

Institution resolved successfully

success
boolean
required
message
string
required
timestamp
string<date-time>
required
data
object
required

Resolved institution details