v1

latestOpenAPI 3.1.02026-08-06134755.4 KB

🇿🇦 South Africa

SAID name match

The South African name match service provides automated, remote identity verification for individuals within South Africa. It uses a person's South African ID number (SAID) together with their first name and last name to check against official records. The service returns a match score along with a detailed description of the verification outcome, enabling quick and reliable identity checks

post/services/za/said/name-match

Request body

said_numberstring required

South African 13-digit national identity number in the format YYMMDDSSSSCAZ: YYMMDD is the date of birth, SSSS is a gender code (0000-4999 female, 5000-9999 male), C is the citizenship indicator (0 citizen, 1 permanent resident), A is a historical digit, and Z is a Luhn checksum digit.

name_match_thresholdnumber float required

The minimum similarity score required to include a name in the search results. A higher value returns fewer, more exact matches, and a lower value returns more results with less similarity

Example request

{
  "said_number": "8001015009031",
  "name_match_threshold": 0.75
}

Response

The request was successful, and our system returned an expected response.

Example response

{
  "validation": {
    "valid": true
  },
  "data": {
    "first_name": "Josh",
    "last_name": "Coffey",
    "service_first_name": "Josh",
    "service_last_name": "Cofey",
    "dob": "1976-02-21",
    "gender": "M",
    "is_citizen": true,
    "name_match_threshold": 0.75,
    "name_match_score": 0.8
  }
}