Statistical Proof of Address

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

Field	Type	Required	Description
`ConsentReceived`	boolean	Yes	Must be `true`
`IdNumber`	string	Yes	SA ID number
`FirstName`	string	Yes	Subject’s first name
`LastName`	string	Yes	Subject’s last name
`AddressLine1`	string	Yes	Street address
`Suburb`	string	No	Suburb
`City`	string	Yes	City
`Province`	string	No	Province
`PostalCode`	string	Yes	Postal code
`CRef`	string	No	Your 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"
}

Field	Description
`addressVerified`	`true` if the address is confirmed as associated with the subject
`matchScore`	Confidence score of the address match (0–100)
`verifiedAddress`	The normalized address as found in the data source

Identity Verification

Biometrics

Compliance & Screening

Financial Verification

Enterprise

Overview

Endpoint

Request

Request Fields

Response

​Overview

​Endpoint

​Request

​Request Fields

​Response

Overview

Endpoint

Request

Request Fields

Response