South Africa 🇿🇦
SA National ID
South Africa 🇿🇦
SA National ID
This endpoint allows you to Lookup a South African National ID.
Request
[GET]
{{baseURL}}/api/v1/za/kyc/id
Header
| Parameter | Type | Description |
|---|---|---|
| AppId | string | you would need to create an app to get your app ID |
| Authorization | string | public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G |
Query partner
| Parameter | Type | Description | |
|---|---|---|---|
| id_number * | string | South African National ID Number | required |
| with_photo | boolean | default is false |
Sample Response
Response
{
"entity": {
"id_number": "1234567890192",
"first_name": "JOHN",
"last_name": "DOE",
"middle_name": "ANON",
"date_of_birth": "1900-01-01",
"phone_number": "",
"address": "",
"photo": "/9j/2wBDA19sjwj2j2j2j2j2j1w",
"marital_status": "SINGLE",
"gender": "Male",
"issued_date": "2020-01-20",
"deceased_status": "Alive",
"citizenship": "SOUTH AFRICAN",
"full_name": "JOHN DOE ANON"
}
}
Was this page helpful?