Customer Verification
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Schema for verifying consumer bank details, including personal identification and banking information. This verification is essential for ensuring compliance and validating customer identities in banking relationships.
The unique identification number of the individual, which may be a national ID number, passport number, or nationa temporary ID number.
The type of identification document provided. Supported ID types: IDNumber, Passport or TempIDNumber.
The first name of the individual.
The middle name of the individual, if applicable.
The last name or surname of the individual.
Initials representing the individual's first and middle names.
The bank account number associated with the individual's bank account.
The type of the bank account. Supported account types include current, savings, transmission, bond, subscription share, or cheque.
The name of the bank associated with the account. Supported banks include: ABSA, ACCESS BANK, AFRICAN BANK, BIDVEST BANK, CAPITEC BANK, DISCOVERY BANK, FINBOND MUTUAL BANK, FNB, GRINROD BANK, INVESTEC BANK, MERCANTILE BANK, NEDBANK, SASFIN BANK, STANDARD BANK , TYME BANK and UBANK.
The email address of the individual
The contact number of the individual.
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
Response object containing the results of the ID verification process within Akibaone.
The result of the endpoint operation, indicating whether the operation was 'Success' or 'Failed'.
Indicates if the ID verification was successful (true) or not (false).
Detailed reason for any verification failure, if applicable.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Ticket number from the /api/consumer/expresstrace service.
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
Response object containing the generated PDF (in Base64-encoded form) and related metadata.
The overall status of the PDF generation request (e.g., 'Success' or 'Failure').
A unique reference number associated with this PDF generation request.
Base64-encoded string representing the generated PDF content.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
The first name of the individual.
The last name of the individual.
The South African identification number of the individual.
Response object containing the results of the ID verification process within Akibaone.
The result of the endpoint operation, indicating whether the operation was 'Success' or 'Failed'.
Indicates if the ID verification was successful (true) or not (false).
Detailed reason for any verification failure, if applicable.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
The first name of the individual.
The last name of the individual.
The South African identification number of the individual.
Response object containing the results of the ID verification process within Akibaone.
The result of the endpoint operation, indicating whether the operation was 'Success' or 'Failed'.
Indicates if the ID verification was successful (true) or not (false).
- : Business related verification on fields such as the business registration number or director information.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
The name of the bank associated with the account. Supported banks include: ABSA, ACCESS BANK, AFRICAN BANK, BIDVEST BANK, CAPITEC BANK, DISCOVERY BANK, FINBOND MUTUAL BANK, FNB, GRINROD BANK, INVESTEC BANK, MERCANTILE BANK, NEDBANK, SASFIN BANK, STANDARD BANK , TYME BANK and UBANK.
The valid account number.
Type of the bank account. Supported values include: unknown, current, savings, transmission, bond, subscriptionshare or cheque.
Type of identification used. Expected values: 'IDNumber', 'Passport', 'TempIDNumber', 'CompanyRegNumber'.
The valid identification number corresponding to the identity type. For 'CompanyRegNumber', the expected format is 'XXXX/XXXXXX/XX'.
First name of the account holder or the registered business name.
Middle name of the account holder.
Last name of the account holder.
Initials of the account holder.
Contact phone number of the account holder.
Email address of the account holder.
The full response object for the compliance KYC process.
The status of the operation, indicating success or failure.
A unique identifier for this application request, used to correlate and track requests throughout the system.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Consumer ID number
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
The status of the response, e.g., 'Success'.
Ticket number
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Consumer ID number
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
RSA ID Number
Base64 encode ID photo
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
Top-level object containing all details and outcomes for live photo and liveness verification of a South African ID using cached data.
Indicates the success or failure of the verification operation.
A unique identifier for this verification request, used for tracking and audit purposes.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
RSA ID Number
Base64 encode ID photo
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
Top-level response object containing metadata and results for South African ID photo verification using cached data.
Indicates the success or failure of the photo verification operation.
Unique identifier for the photo verification request, used for tracking and correlation.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
RSA ID Number
First name
Last name
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
Top-level response structure for a cached/offline South African ID verification request.
Indicates whether the overall verification operation was successful or not.
A unique identifier for the ID verification request, used for tracking and correlation.
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
South African ID number
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
South African ID number
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
South African contact number; eg: Landline 0122215554 or mobile 0823336666.
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
South African ID number
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
- : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
A string representing the customer's known nationalities, formatted as 2-character country codes separated by commas (e.g., 'NG, ZA'). Country codes are as follows: Nigeria = NG, South Africa = ZA, Ghana = GH, Zambia = ZM and Zimbabwe = ZW
Id type - for Zimbabwe and South Africa = NATIONAL_ID_NO_PHOTO, for Ghana = PASSPORT, SSNIT, VOTER_ID or NEW_VOTER_ID, for Nigeria = BVN, NIN_V2, NIN_SLIP, V_NIN, DRIVERS_LICENSE, or VOTER_ID, and for Zambia = TPIN
ID number - If country is Zambia put TPIN (Tax Id Number)
First name
Last name
Date of birth
Gender - Male = M or Female = F
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
Root response object for KYC verification containing identity and result details.
Overall status of the verification request (e.g., Success, Failed).
Unique identifier for this verification request.
Indicates whether the response is the final result of the verification process.
Human-readable description of the result (e.g., ID Number Validated).
Type of result returned (e.g., ID Verification).
Country code of the ID being verified (e.g., ZA).
The ID number that was verified.
The type of ID document (e.g., NATIONAL_ID_NO_PHOTO).
Residential or official address, if available.
Date of birth of the individual.
Associated document (e.g., copy of ID), if available.
Date the ID document expires, if applicable.
Concatenated full name of the individual.
Gender of the individual.
Date the ID document was issued.
Primary phone number on record, if available.
Secondary phone number on record, if available.
Photo of the individual, if available.
Any secondary or alternative ID number, if applicable.
Alternative names or aliases, if any.
Indicates whether the individual is currently alive according to the source data.
Timestamp when the verification response was generated.
Last updated