Phone Number
Required Inputs
country
ZA
id_type
PHONE_NUMBER
id_number
Phone Number
Response Fields
Country
YES
IDType
YES
IDNumber
YES
SecondaryIDNumber
YES
IssuanceDate
NO
ExpirationDate
N/A
FullName
YES
DOB
NO
Photo
NO
PhoneNumber
NO
PhoneNumber2
NO
Document
NO
Gender
NO
Address
NO
All fields are returned as string
ID Number Regular Expression (Regex)
To limit the probability of your user mistyping the id number, we advice that you enforce the format of the id number field in your app. You can use the regex below:
/^[0-9]{10}$/
Supported Products
The South Africa phone number can be used on any of the following products:
For the supported integration options, you can check the integration options supported by each product here.
⚠ Important: For Basic KYC, we can only match the following fields: first_name, middle_name, last_name.
Sample ID Numbers
To test the South African phone number service in our Sandbox, we provide you with 5 different id numbers to mirror various scenarios you can experience with real IDs in production.
0000000000
Success with PII return
1012
0000000001
Failure, no record found
1013
0000000002
Invalid ID number format
1014
0000000003
Database unavailable/unknown network issue
1015
0000000004*
Success with custom PII return
1012
* You can read more about customising the PII response in sandbox in our documentation here.
Last updated
Was this helpful?