Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint checks the registration status of a subject within the didx:verify system.

​
Endpoint

POST /Citizen/GetRegistrationStatus

​
Request

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/GetRegistrationStatus" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "IdNumber": "8001014800080",
    "CRef": "REF00001"
  }'

​
Request Fields

FieldTypeRequiredDescription
ConsentReceivedbooleanYesMust be true
IdNumberstringYesSA ID number to check
CRefstringNoYour transaction reference

​
Response

{
  "IsRegistered": true,
  "RegistrationDate": "2024-01-15T08:30:00Z",
  "Status": "Success",
  "CRef": "REF00001"
}
FieldDescription
IsRegisteredtrue if the subject has a registration record in the system
RegistrationDateDate the subject was registered