Skip to main content

​
Request

[GET]
{{baseUrl}}/api/v1/kyc/nuban
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Query parameters

ParameterTypeDescriptionRequired
account_number *stringBank account numberrequired
bank_code *integerBank Coderequired
The bank codes can be gotten from this endpoint.

​
Sample response

Response
{
  "entity": {
    "account_currency": "566",
    "account_name": "MICHEAL ADEOSUN GABRIEL",
    "account_number": "3046***407",
    "account_type": "10",
    "address_1": ".",
    "address_2": "",
    "city": "LAGOS",
    "country_code": "",
    "country_of_birth": "",
    "country_of_issue": "",
    "dob": "10/06/1982",
    "expiry_date": "",
    "first_name": "John",
    "identity_number": "222******556",
    "identity_type": "BVN",
    "last_name": "ADEOSUN",
    "nationality": "",
    "other_names": "GABRIEL",
    "phone": "2348****77844",
    "postal_code": "234",
    "state_code": "LAGOS"
  }
}

​
Response Fields

FieldTypeDescription
entityobjectContains the account verification response data
entity.account_currencystringCurrency code of the bank account
entity.account_namestringFull name on the bank account
entity.account_numberstringMasked bank account number
entity.account_typestringType code of the bank account
entity.address_1stringPrimary address of the account holder
entity.address_2stringSecondary address of the account holder
entity.citystringCity of the account holder
entity.country_codestringCountry code of the account holder
entity.country_of_birthstringCountry of birth of the account holder
entity.country_of_issuestringCountry of issue for the identity document
entity.dobstringDate of birth of the account holder (DD/MM/YYYY)
entity.expiry_datestringExpiry date of the identity document (DD/MM/YYYY)
entity.first_namestringFirst name of the account holder
entity.identity_numberstringMasked identity number linked to the account
entity.identity_typestringType of identity document linked (e.g., BVN)
entity.last_namestringLast name of the account holder
entity.nationalitystringNationality of the account holder
entity.other_namesstringOther names (middle name) of the account holder
entity.phonestringMasked phone number of the account holder
entity.postal_codestringPostal code of the account holder
entity.state_codestringState of residence of the account holder

​
Test Credentials for Sandbox

Kindly use this Test NUBAN in sandbox Environment Account Number = 3046507407 Bank Code = 011