National ID

National ID Lookup endpoint gives all the details about a user in South Africa including their full name, date of birth, gender among other things.

Request:

{
    "template_id" : "ZA_NATIONAL_ID",
    "user_data": {
        "identity": {
            "identity_country_code": "ZA",
            "identity_number_type": "NATIONAL_ID",
            "identity_number": "{{Valid_National_ID_Number}}"
        },
    }
}

Response:

{
  "aiprise_summary": {
    "verification_result": "APPROVED"
  },
  "client_reference_id": null,
  "created_at": "<TimestampMillis>",
  "id_info": {
    // Normalized fields.
    "birth_date": "YYYY-MM-DD",
    "full_name": "",
    "gender": "",
    "id_number": "",
    "id_type": "",
    "issue_country_code": "",
    "issue_country": "",
    
    // Government lookup details.
    "lookup_details": {
      "lookup_list": [
        {
          "source": "South African Department of Home Affairs",
          "lookup_type": "NATIONAL_ID",
          "lookup_data": {
            "birth_date": "YYYY-MM-DD",
            "full_name": "",
            "gender": "",
            "id_number": "",
            "issue_country_code": "",
            "user_photo": "<Base64String>"
          }
        }
      ]
    },
    "result": "APPROVED"
  },
  "status": "COMPLETED",
  "template_id": "",
  "verification_session_id": ""
}