Statistical Proof of Address - DIDx Developer Documentation

Overview

This endpoint returns the address information on record for a South African ID number, drawn from statistical data sources. You send an ID number. You get back the known addresses for that person, which you can compare with the address your subject gives you.

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",
    "CRef": "REF00001"
  }'

Request Fields

Field	Type	Required	Description
`ConsentReceived`	boolean	Yes	Must be `true`
`IDNumber`	string	No	ID number of the subject whose address you want to look up
`CRef`	string	No	Your transaction reference

Response

{
  "response_object": {
    "ci": {
      "responses": "string",
      "addresses": [
        {
          "name": "123 Main Street",
          "suburbName": "Sandton",
          "townName": "Johannesburg",
          "provinceName": "Gauteng",
          "countryName": "South Africa",
          "streetCode": "string",
          "typeId": "string",
          "centreLat": "string",
          "centreLon": "string",
          "createdDate": "2020-01-01",
          "lastUpdated": "2024-01-01"
        }
      ],
      "phoneNumbers": "string"
    },
    "av": {
      "summary": "string",
      "responses": ["string"]
    },
    "basic": [
      {
        "line1": "123 Main Street",
        "line2": "Sandton",
        "line3": "Johannesburg",
        "line4": "Gauteng",
        "postalCode": "2196",
        "firstReportDate": "2020-01-01",
        "lastUpdateDate": "2024-01-01"
      }
    ]
  },
  "result": true,
  "result_code": {
    "name": "Success",
    "id": 0
  },
  "CRef": "REF00001",
  "Status": "Success",
  "Message": "string"
}

Response Fields

Field	Description
`result`	`true` if the lookup succeeded
`response_object.ci.responses`	Summary of the response received
`response_object.ci.addresses`	Addresses on record, with suburb, town, province, and country
`response_object.ci.phoneNumbers`	Phone numbers on record for the subject
`response_object.av.summary`	Summary of the address validation
`response_object.av.responses`	Responses from the address validation
`response_object.basic`	Basic address records
`basic[].line1` to `line4`	Street, suburb, city, and province
`basic[].postalCode`	Postal code
`basic[].firstReportDate`	Date the address was first reported
`basic[].lastUpdateDate`	Date the address record was last updated