National ID

Verify a South African national ID number and return holder details.

Test data

Sandbox test data

Use these values against the sandbox host. Click a value to copy it.

Sample RSA ID (fictional)

Request

POST/api/v1/id/za

{{baseUrl}}/api/v1/id/za

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
id_number	string	13-digit RSA ID number	required
consent	boolean	Must be true — confirms data-subject consent to perform this verification	required
customer_number	string	Optional reference for your own tracking (max 255 characters)	optional

Sample request & response

Sample request body for Sample request & response:

Sample dataSample request body

{
  "id_number": "9001015800085",
  "consent": true
}

Sample response for Sample request & response:

200 OKSample dataSample response

{
  "success": true,
  "response_code": 200,
  "message": "South Africa ID details fetched successfully",
  "country": "za",
  "data": {
    "id_number": "9001015800085",
    "first_name": "Thabo",
    "last_name": "Ndlovu",
    "middle_name": null,
    "name": "Thabo Ndlovu",
    "gender": "Male",
    "dob": "1990-01-01",
    "marital_status": "Single",
    "living_status": "Alive",
    "phone_number": "+27821234567",
    "address": "123 Sample Street, Johannesburg",
    "issued_date": "2010-06-15",
    "photo_url": null,
    "valid": true
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails
country	string	Country code — always "za" for this route
data.id_number	string	National ID number
data.first_name	string	Given name
data.last_name	string	Surname
data.middle_name	string	Middle name when available
data.name	string	Full display name
data.gender	string	Gender
data.dob	string	Date of birth (YYYY-MM-DD)
data.marital_status	string	Marital status when available
data.living_status	string	Living status when available
data.phone_number	string	Phone number when available
data.address	string	Address when available
data.issued_date	string	Issue date when available
data.photo_url	string	Photo URL when available
data.valid	boolean	Whether the ID is valid

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

Code	When	Billed?
200	South Africa ID details returned successfully	Yes
400	Validation — missing/invalid id_number, consent (must be true), or South Africa-specific fields	No
401	Missing or invalid Bearer token	No
402	Insufficient wallet balance or credit limit	No
403	No active wallet or billing profile (or service not enabled)	No
404	South Africa ID not found — or unsupported country	Yes for ID-not-found; No for unsupported country
408	Upstream timeout / service error	No
429	Rate limited	No
502	Upstream bad or unreadable response	No
503	Upstream connection unavailable	No

400 — validation

400Sample data400 — validation

{
  "success": false,
  "response_code": 400,
  "message": "The consent field is required",
  "country": "za",
  "errors": {
    "consent": "The consent field is required"
  },
  "data": null,
  "request_id": "550e8400-e29b-41d4-a716-446655440010"
}

404 — ID not found

404Sample data404 — ID not found

{
  "success": false,
  "response_code": 404,
  "message": "South Africa ID not found",
  "description": "There is no information for requested search parameters",
  "country": "za",
  "data": null,
  "request_id": "550e8400-e29b-41d4-a716-446655440013"
}

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.