National ID
Last updated
Last updated
| Input | Value |
|---|---|
country | ZA |
id_type | NATIONAL_ID |
id_number | National identity number |
| Response Field | Value Returned |
|---|---|
Country | YES |
IDType | YES |
IDNumber | YES |
IssuanceDate | NO |
ExpirationDate | N/A |
FullName | YES |
DOB | YES |
Photo | YES |
PhoneNumber | NO |
PhoneNumber2 | NO |
Document | NO |
Gender | YES |
Address | NO |
All fields are returned as string.
Beyond the standard top-level keys listed in the table above, additional metadata as Deceased Status, haIdBookIssuedDate, citizenship, age, country of birth can be found in the FullData Object of the response share. Click here to see a sample of the JSON response
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]{13}$/
The South Africa national id 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.
To test the South Africa national id in our Sandbox, we provide you with 5 different id numbers to mirror various scenarios you can experience with real IDs in production.
| ID Number | Result | Result Code |
|---|---|---|
0000000000000 | Success with PII return | 1012 |
0000000000001 | Failure, no record found | 1013 |
0000000000002 | Invalid ID number format | 1014 |
0000000000003 | Database unavailable/unknown network issue | 1015 |
0000000000004* | Success with custom PII return | 1012 |
* to get a successful Biometric KYC, you will need to pass a custom photo. You can read more about customising the PII response in sandbox in our documentation here.
