Customer Verification

post

Basic bank account verification for South African individuals, returning the verification status, result, and any failure reasons if verification is unsuccessful.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body

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.

id_numberstringOptional

The unique identification number of the individual, which may be a national ID number, passport number, or nationa temporary ID number.

identity_typestringOptional

The type of identification document provided. Supported ID types: IDNumber, Passport or TempIDNumber.

first_namestringOptional

The first name of the individual.

middle_namestringOptional

The middle name of the individual, if applicable.

last_namestringOptional

The last name or surname of the individual.

initialsstringOptional

Initials representing the individual's first and middle names.

account_numberstringOptional

The bank account number associated with the individual's bank account.

account_typestringOptional

The type of the bank account. Supported account types include current, savings, transmission, bond, subscription share, or cheque.

bank_namestringOptional

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.

emailstringOptional

The email address of the individual

contact_numberstringOptional

The contact number of the individual.

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json

Response object containing the results of the ID verification process within Akibaone.

StatusstringOptional

The result of the endpoint operation, indicating whether the operation was 'Success' or 'Failed'.

VerificationbooleanOptional

Indicates if the ID verification was successful (true) or not (false).

OutcomeReasonstringOptional

Detailed reason for any verification failure, if applicable.

post
/api/v3/bankverification/consumer
post

This service generates a consumer trace PDF report and returns a status, a ticket number, and the PDF in Base64 format.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
ticket_numberstringOptional

Ticket number from the /api/consumer/expresstrace service.

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json

Response object containing the generated PDF (in Base64-encoded form) and related metadata.

StatusstringOptional

The overall status of the PDF generation request (e.g., 'Success' or 'Failure').

TicketNumberstringOptional

A unique reference number associated with this PDF generation request.

PDFBytesstringOptional

Base64-encoded string representing the generated PDF content.

post
/api/consumer/expresstrace/pdfreport
post

Basic ID verification for South African individuals, returning the verification status, result, and any failure reasons if verification is unsuccessful.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
first_namestringOptional

The first name of the individual.

last_namestringOptional

The last name of the individual.

id_numberstringOptional

The South African identification number of the individual.

Responses
chevron-right
200Success
application/json

Response object containing the results of the ID verification process within Akibaone.

StatusstringOptional

The result of the endpoint operation, indicating whether the operation was 'Success' or 'Failed'.

VerificationbooleanOptional

Indicates if the ID verification was successful (true) or not (false).

OutcomeReasonstringOptional

Detailed reason for any verification failure, if applicable.

post
/api/v4/idverification
post

The Know Your Customer (KYC) Verification Endpoint is designed to authenticate and validate the identities of individuals by verifying key personal information. This process ensures that individuals are who they claim to be, thereby mitigating risks associated with fraudulent activities and aiding compliance with regulatory requirements.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
first_namestringOptional

The first name of the individual.

last_namestringOptional

The last name of the individual.

id_numberstringOptional

The South African identification number of the individual.

Responses
chevron-right
200Success
application/json

Response object containing the results of the ID verification process within Akibaone.

StatusstringOptional

The result of the endpoint operation, indicating whether the operation was 'Success' or 'Failed'.

VerificationbooleanOptional

Indicates if the ID verification was successful (true) or not (false).

post
/api/kyc/verification
post

A comprehensive bank account verification report designed for both individual consumers and business entities. This report provides detailed verification results, including account status, identity matches, and compliance information, to support Know Your Customer (KYC) processes and ensure accurate and reliable account validations.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : 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.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
bank_namestringOptional

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.

account_numberstringOptional

The valid account number.

account_typestringOptional

Type of the bank account. Supported values include: unknown, current, savings, transmission, bond, subscriptionshare or cheque.

identity_typestringOptional

Type of identification used. Expected values: 'IDNumber', 'Passport', 'TempIDNumber', 'CompanyRegNumber'.

id_numberstringOptional

The valid identification number corresponding to the identity type. For 'CompanyRegNumber', the expected format is 'XXXX/XXXXXX/XX'.

first_namestringOptional

First name of the account holder or the registered business name.

middle_namestringOptional

Middle name of the account holder.

last_namestringOptional

Last name of the account holder.

initialsstringOptional

Initials of the account holder.

contact_numberstringOptional

Contact phone number of the account holder.

emailstringOptional

Email address of the account holder.

Responses
chevron-right
200Success
application/json

The full response object for the compliance KYC process.

StatusstringOptional

The status of the operation, indicating success or failure.

ApplicationIdstringOptional

A unique identifier for this application request, used to correlate and track requests throughout the system.

post
/api/v1/bankverification
post

The Consumer Express Trace service enables a user to submit a South African ID Number and in return the user will receive the following information, Registered Names and Surname, Date of Birth., Age, Gender, Last 5 Know Addresses, Last 5 Know Telephones, Last 5 Know employers and Deceased Status.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

Consumer ID number

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json
ResponseStatusstringOptional

The status of the response, e.g., 'Success'.

TicketNumberstringOptional

Ticket number

post
/api/consumer/expresstrace
post

The Consumer Trace service enables a user to submit a South African ID Number and in return the user will receive the following information, Registered Names and Surname, Date of Birth., Age, Gender, Last 5 Know Addresses, Last 5 Know Telephones, Last 5 Know employers and Deceased Status.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

Consumer ID number

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json
ResponseStatusstringOptional
post
/api/v2/consumertrace
post

Biometric ID check using an ID number and photo. Verified in real-time using offline database resources. Including a liveliness check.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

RSA ID Number

id_photostringOptional

Base64 encode ID photo

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json

Top-level object containing all details and outcomes for live photo and liveness verification of a South African ID using cached data.

StatusstringOptional

Indicates the success or failure of the verification operation.

ApplicationIdnumberOptional

A unique identifier for this verification request, used for tracking and audit purposes.

post
/api/liveidphotoverification
post

Performs basic ID photo verification for a South African ID number and ID phot using offline database sources. This endpoint does not use real-time data from the Department of Home Affairs (DHA).

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

RSA ID Number

id_photostringOptional

Base64 encode ID photo

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json

Top-level response object containing metadata and results for South African ID photo verification using cached data.

StatusstringOptional

Indicates the success or failure of the photo verification operation.

ApplicationIdintegerOptional

Unique identifier for the photo verification request, used for tracking and correlation.

post
/api/v2/idphotoverification
post

Performs ID verification for a South African ID number using offline database sources. This endpoint does not use real-time data from the Department of Home Affairs (DHA).

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

RSA ID Number

first_namestringOptional

First name

last_namestringOptional

Last name

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json

Top-level response structure for a cached/offline South African ID verification request.

StatusstringOptional

Indicates whether the overall verification operation was successful or not.

ApplicationIdintegerOptional

A unique identifier for the ID verification request, used for tracking and correlation.

post
/api/v3/idverification
post

Consumer Trace service that provides detailed information such as registered names, surname, date of birth, last known addresses, phone numbers, employers, and deceased status, based on a South African ID number.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

South African ID number

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json
StatusstringOptional
transaction_idintegerOptional
post
/api/consumertrace
post

Performs ID verification for a South African ID number using offline database sources.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

South African ID number

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json
FirstnamesstringOptional
LastnamestringOptional
DobstringOptional
AgeintegerOptional
GenderstringOptional
CitizenshipstringOptional
DateIssuedstringOptional
post
/api/idverification
post

Obtain the last known South African identities associated with a contact number, using either a landline or mobile number as the search criteria.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
contact_numberstringOptional

South African contact number; eg: Landline 0122215554 or mobile 0823336666.

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json
StatusstringOptional
post
/api/searchphonenumber
post

Real-time verification of deceased status and name change information from Home Affairs using a South African ID number.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

South African ID number

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json
idNumberstringOptional
inputIdnostringOptional
haIdnostringOptional
haIdBookIssuedDatestringOptional
idCardIndstringOptional
idCardDatestringOptional
identityDocumentTypestringOptional
idBlockedstringOptional
firstNamesstringOptional
surNamestringOptional
dobstringOptional
agestringOptional
genderstringOptional
citizenshipstringOptional
countryofBirthstringOptional
deceasedStatusstringOptional
deceasedDatestringOptional
deathPlacestringOptional
causeOfDeathstringOptional
maritalStatusstringOptional
marriageDatestringOptional
post
/api/realtimeidverification
post

Verify an ID number and correonding details for supported countries. This API supports Zimbabwe(ZW), Nigeria (NG), South Africa (ZA), Ghana (GH) and Zambia (ZM). Note: Pricing differs from V1.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : These APIs allow you to connect and verify customer data such as bank account, bank statement, identity data and company registration data.
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
country_codestringOptional

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_typestringOptional

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_numberstringOptional

ID number - If country is Zambia put TPIN (Tax Id Number)

first_namestringOptional

First name

last_namestringOptional

Last name

dobstring · dateOptional

Date of birth

genderstringOptional

Gender - Male = M or Female = F

consentbooleanOptional

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

Responses
chevron-right
200Success
application/json

Root response object for KYC verification containing identity and result details.

StatusstringOptional

Overall status of the verification request (e.g., Success, Failed).

ApplicationIdstringOptional

Unique identifier for this verification request.

IsFinalResultstringOptional

Indicates whether the response is the final result of the verification process.

ResultTextstringOptional

Human-readable description of the result (e.g., ID Number Validated).

ResultTypestringOptional

Type of result returned (e.g., ID Verification).

CountrystringOptional

Country code of the ID being verified (e.g., ZA).

IDNumberstringOptional

The ID number that was verified.

IDTypestringOptional

The type of ID document (e.g., NATIONAL_ID_NO_PHOTO).

AddressstringOptional

Residential or official address, if available.

DOBstringOptional

Date of birth of the individual.

DocumentstringOptional

Associated document (e.g., copy of ID), if available.

ExpirationDatestringOptional

Date the ID document expires, if applicable.

FullNamestringOptional

Concatenated full name of the individual.

GenderstringOptional

Gender of the individual.

IssuanceDatestringOptional

Date the ID document was issued.

PhoneNumberstringOptional

Primary phone number on record, if available.

PhoneNumber2stringOptional

Secondary phone number on record, if available.

PhotostringOptional

Photo of the individual, if available.

Secondary_ID_NumberstringOptional

Any secondary or alternative ID number, if applicable.

OtherNamesstringOptional

Alternative names or aliases, if any.

IsAlivebooleanOptional

Indicates whether the individual is currently alive according to the source data.

timestampstring · date-timeOptional

Timestamp when the verification response was generated.

post
/api/v2/idverification

Last updated