​
SA National ID without photograph

​
Request

[GET]
{{baseURL}}/api/v1/za/kyc/id
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
Authorizationstringpublic secret key

​
Query parameter

ParameterTypeDescriptionRequired
id_number *stringSouth African National ID Numberrequired

​
Sample Response

Response
{
    "entity": {
        "id_number": "1234567890192",
        "first_name": "JOHN",
        "last_name": "DOE",
        "middle_name": "ANON",
        "date_of_birth": "1900-12-18",
        "phone_number": "",
        "address": "",
        "marital_status": "SINGLE",
        "gender": "Male",
        "issued_date": "2020-01-20",
        "full_name": "JOHN DOE ANON",
        "smart_card_issued": "YES",
        "card_date": "2020-01-20",
        "book_date": "2020-01-20",
        "living_status": "ALIVE"
    }
}

​
SA National ID with photograph

​
Request

[GET]
{{baseURL}}/api/v1/za/kyc/id_withphoto

​
Header

HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
Authorizationstringpublic secret key

​
Query parameter

ParameterTypeDescriptionRequired
id_number *stringSouth African National ID Numberrequired

​
Sample Response

Response
{
    "entity": {
        "id_number": "1234567890192",
        "first_name": "JOHN",
        "last_name": "DOE",
        "middle_name": "ANON",
        "date_of_birth": "1900-12-18",
        "phone_number": "",
        "address": "",
        "photo": "/9j/2wBDA19sjwj2j2j2j2j2j1w",
        "marital_status": "SINGLE",
        "gender": "Male",
        "issued_date": "2020-01-20",
        "full_name": "JOHN DOE ANON",
        "smart_card_issued": "YES",
        "card_date": "2020-01-20",
        "book_date": "2020-01-20",
        "living_status": "ALIVE"
    }
}