UfitPay Identity verification API is designed for developers to easily integrate instant identity verification functionality on any application using any software programing technology or development platform
Access to this API is available to all registered UfitPay customers and agents (wallet accounts). You will likely need access to a web developer or programmer (if you’re not one) to get the most use out of UfitPay API.
In order to interact with UfitPay ID verification APIs, you need to enable API access on your account. To do this, go to Account Settings on the UfitPay Mobile App then click the Generate API Keys link. We will generate and send new API credentials to your registered email address;
Once generated, you will be able to retrieve your API credentials at any time by the View API keys link.
For added security, we recommend you restrict access to your API credentials to only white-listed IP addresses. You can do this by clicking the Restrict API Access link under Account Settings on UfitPay Mobile App.
All requests to this API require HTTP Header Authentication over TLS (HTTPS).
To authenticate your request, you need to pass the following parameters as part of your HTTP request headers;
Api-Key: Your wallet API key
API-Token: Your wallet API token
The following API Credentials can be used for development and test purpose only. Transactions done using these credentials are not treated as live
Test Wallet API Key: TSVLWCB5TO5RfJFCNkwSX8z0F8ZwD91
Test Wallet API Token: TS66uEwtekJEcWiwzC1gDdiDzKcJFk1
This API allows you to verify if your customer's real identity match what they provided to you, using Drivers License, National Identification Number (NIN) or Bank Verification Number (BVN). This endpoint is accessed by making an HTTP POST request to
Please note that this endpoint is not free. A ₦20 charge applies per BVN verification request while a ₦100 charge applies for all other identity request.
| Request Body Parameters | |
| id_number (string) | (required) This is the identity number to be verified |
| id_type (string) | (required) This is the identity type you wish to verify. Supported values include bvn, nin or drivers_license |
| first_name (string) | (required) First name of the person whose ID is being verified. |
| last_name (string) | (required) Last name of the person whose ID is being verified. |
| middle_name (string) | (optional) middle name of the person whose ID is being verified. |
| account_number (string) | (required for BVN) A 10 digit bank account number already linked with the BVN being verified. |
| bank_code (string) | (required for BVN) The bank code for the account number supplied above. (Refer to Bank List API for supported bank codes) |
Sample success response (json)
{
"resource": "identity",
"status":"success",
"data":{
"verify_status": "valid",
"first_name": "John",
"last_name": "Doe",
"address": "123 XYZ Street, Wuse, Abuja",
"id_number": "10000000001",
"id_type": "nin",
"date_of_birth": "2001-07-21"
}
}
| Response parameters | |
| verify_status (string) | This is the result of the verified identity. Possible values are valid (if the ID number is valid but not matched), matched (if the ID name matched the supplied name ) or invalid (if the ID number is not found on the identity database ) |
| address (string) | This is registered business address returned for the verified company |
| first_name (string) | This is the first name returned for the verified identity |
| last_name (string) | This is the last name returned for the verified identity |
| id_number (string) | This is the ID number verified |
| id_type (string) | This is the type of ID verified |
| date_of_birth (string) | This is the date of birth returned for the verified identity. This is not included on BVN verifications |
This API allows you to verify if your customer's real business name match what they provided to you CAC Registration Number. This endpoint is accessed by making an HTTP POST request to
Please note that this endpoint is not free. A ₦100 charge applies per verification request.
| Request Body Parameters | |
| id_number (string) | (required) This is the identity number to be verified |
| id_type (string) | (required) This is the identity type you wish to verify. Supported values cac |
| company (string) | (required) This is the Full Registered name of the company being verified eg. ABC Company Limited) |
Sample success response (json)
{
"resource": "identity",
"status":"success",
"data":{
"verify_status": "valid",
"address": "No 1, Some Street, Lagos, Nigeria",
"company": "ABC Comapny Limited",
"id_number": "0123456",
"id_type": "cac",
"registration_date": "2022-07-21"
}
}
| Response parameters | |
| verify_status (string) | This is the result of the identity verification. Possible values are valid (if the CAC number is valid but company name was not matched), matched (if the company name match the supplied name ) or invalid (if the CAC number is not found on the identity database ) |
| address (string) | This is registered business address returned for the verified company |
| company (string) | This is the registered name returned for the verified company |
| id_number (string) | This is the ID number verified |
| id_type (string) | This is the type of ID verified |
| registration_date (string) | This is the registration date returned for the verified company |
This API allows you to check the network operator of a given phone number. This endpoint is accessed by making an HTTP POST request to
Please note that this endpoint is not free. A ₦1 charge applies per successful request
| Request Body Parameters | |
| phone_number (string) | (required) This is the mobile phone number you wish to get network operator for. This needs to be in international format |
| country (string) | (optional) This is the 2 character country code of the number origin. Default value is NG |
Sample success response (json)
{
"resource": "number_validate",
"status":"success",
"data":{
"mobile_number": "08031234567",
"operator_name": "MTN Nigeria",
"vendor_id": "0023"
}
}
| Response parameters | |
| mobile_number (string) | This is the mobile number validated |
| operator_name (string) | This is the name of the mobile network operator |
| vendor_id (int) | This is the UfitPay unique vendor ID for the operator (if supported) |
This API allows you to fetch the correct postal code or ZIP for a given state. This endpoint is accessed by making an HTTP POST request to
Please note that this endpoint is not free. A ₦1 charge applies per successful look-up
| Request Body Parameters | |
| state (string) | (required) This is the name of the state you wish to get ZIP or postal code for. This needs to be the correct and exact state name (e.g. Lagos, New York) |
Sample success response (json)
{
"resource": "postal_code",
"status":"success",
"data":{
"postal_code": "12345678"
}
}
| Response parameters | |
| postal_code (string) | This is the ZIP or Postal Code returned from the look-up |
Copyright @2024 Ynet Technology Ltd. All Rights Reserved