Skip to main content

​
Overview

This endpoint validates a subject’s address using statistical data — cross-referencing the provided address against known address data to confirm it is associated with the individual.

​
Endpoint

POST /Citizen/StatisticalProofOfAddress

​
Request

curl -X POST "https://citizen.uat.securecitizen.cloud/Citizen/StatisticalProofOfAddress" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ConsentReceived": true,
    "IdNumber": "8001014800080",
    "FirstName": "John",
    "LastName": "Doe",
    "AddressLine1": "123 Main Street",
    "Suburb": "Sandton",
    "City": "Johannesburg",
    "Province": "Gauteng",
    "PostalCode": "2000",
    "CRef": "REF00001"
  }'

​
Request Fields

FieldTypeRequiredDescription
ConsentReceivedbooleanYesMust be true
IdNumberstringYesSA ID number
FirstNamestringYesSubject’s first name
LastNamestringYesSubject’s last name
AddressLine1stringYesStreet address
SuburbstringNoSuburb
CitystringYesCity
ProvincestringNoProvince
PostalCodestringYesPostal code
CRefstringNoYour transaction reference

​
Response

{
  "data": {
    "addressVerified": true,
    "matchScore": 85,
    "verifiedAddress": {
      "AddressLine1": "123 Main Street",
      "Suburb": "Sandton",
      "City": "Johannesburg",
      "Province": "Gauteng",
      "PostalCode": "2000"
    },
    "resultDescription": "Address verified against statistical data"
  },
  "Status": "Success",
  "CRef": "REF00001"
}
FieldDescription
addressVerifiedtrue if the address is confirmed as associated with the subject
matchScoreConfidence score of the address match (0–100)
verifiedAddressThe normalized address as found in the data source