Proof of Address

Verification service for proof of address with global coverage.

Endpoint

POST /civil-registry/proofofaddress

Authentication

Type	Location	Name
API Key	Header	x-api-key

Request example

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/proofofaddress' \
--data-raw '{
  "TransmissionReference":"",
  "Actions":"Check,Verify",
  "AddressOptions":"",
  "EmailOptions":"",
  "PhoneOptions":"",
  "NameOptions":"NameHint:DefinitelyFull",
  "Options":"",
  ...
}' \
--header 'x-api-key: {API_KEY}'

Responses

200 Success

Response example

{
  "Address": {
    "AddressKey": "{{addressKey}}",
    "AddressLine1": "{{addressLine1}}",
    "AddressLine2": "{{addressLine2}}",
    "AddressLine3": "{{addressLine3}}"
  },
  "Email": {
    "BreachCount": "",
    "DateChecked": "8/24/2023 9:51:25 PM",
    "DeliverabilityConfidenceScore": "55",
    "DomainAddress1": ""
  },
  "Identity": {
    "AccountNumber": {
      "Validated": ""
    },
    "BusinessInformation": {
      "ID": "",
      "Name": "",
      "RegistrationDate": "",
      "Status": "",
      "Type": ""
    },
    "Confidence": "High",
    "Datasources": [
      {
        "DatasourceName": "Credit-1",
        "Messages": [
          {
            "Description": "First/given/forename matched",
            "ResultCode": "KV03"
          },
          {
            "Description": "Full match was made on First Initial",
            "ResultCode": "KV31"
          },
          {
            "Description": "Last/surname name matched",
            "ResultCode": "KV04"
          }
        ],
        "Results": "KV03,KV31,KV04,KV01,KV10,KV11,KV12,KV13,KV14"
      }
    ],
    "DateOfBirth": "{{dateOfBirth}}",
    "NationalID": "{{nationalId}}",
    "Results": "KV03,KV31,KV04,KV01,KV10,KV11,KV12,KV13,KV14",
    "WatchlistPersons": "",
    "Watchlists": {
      "Articles": [],
      "Hit": "",
      "ReportLink": "",
      "Sources": []
    }
  },
  "Name": {
    "Company": "",
    "Gender": "",
    "Gender2": "",
    "NameFirst": "{{nameFirst}}"
  },
  "Phone": {
    "AdministrativeArea": "",
    "CallerID": "",
    "Carrier": "EE Limited (Orange)",
    "CountryAbbreviation": "GB"
  },
  "Results": "",
  "TransactionID": "{{transactionId}}",
  "TransmissionReference": "",
  "Version": "7.2.0.1214"
}

400 Bad Request

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

502 Bad Gateway

{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}

504 Gateway Timeout

{
  "message": "Endpoint request timed out"
}