To perform a new Address/Mortality/DOB check you must send a POST request to the /api/v2/ci/entities/{entityId}/data-checks/address-mortality endpoint.
You must specify an entityId as part of this request. If you do not have an existing Entity that you wish to use you must first create an Entity - see the Create a new Entity page for more details on this.
As part of your request you must specify a request body, such as:
{
"firstName": "string",
"middleNames": "string",
"surname": "string",
"dateOfBirth": "2024-03-12T11:39:48.752Z",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postcode": "string",
"county": "string",
"country": "string"
}
Response body
This is a synchromous routine, so the response you receive will contain the result and any accompanying remarks.
{
"id": 0,
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dateCreated": "2024-03-12T11:39:48.755Z",
"resultText": "string",
"result": 1,
"dataSources": [
{
"name": "string",
"description": "string",
"remarks": [
{
"type": 0,
"description": "string"
}
]
}
],
The key parameters in this response are:
result
This is the overall result of the check, and will be one of the following values:
1 | Pass |
2 | Refer |
| 3 | Fail |
remarks
A collection of remarks may be returned, each with a type and a description.
Type will be one of the following values:
0 | Comment |
1 | Match |
| 2 | Warning |
| 3 | Mismatch |
Description will provide a textural comment for the remark, such as 'Name matched on electoral register'.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article