Skip to main content
Identify is a single endpoint: POST /v1/identify. The response data is this object.
With holder resolution (nuban + account_number):

Attributes

enum
required
Outcome of the lookup. One of identified, not_found, unsupported. Only identified is billed.
string
required
Rail that was resolved. One of swift, iban, routing_number, sort_code, ifsc, nuban, gh_bank, ke_bank, momo, za_bank, ci_bank, eg_bank, rw_bank.
string
ISO 3166-1 alpha-2 of the institution, when known.
object
The identified financial institution. Omitted when result is not identified.
string[]
Payment rails the institution can be reached on (ach, wire, rtp, nip, ghipss, kepss, pesalink, …).
object
Present when you supplied account_number.
timestamp
Present only when result is identified.
If a field is unknown we omit it. See the Identify guide for rails and examples, the POST /v1/identify page for the request, or GET /v1/identify/banks for the codes each rail takes.