Receiving a response from the Smartlink web service
When a request is made, the response will be returned in just a few seconds. Responses will return the details of any Smartlink address links that match the name and address provided; or, in the event of an error, will return an error message.
Responses are provided as JSON encoded objects containing response parameters, the possible values of which are highlighted below.
Response Parameters
| Parameter | Data Type | Format Provided | Notes |
|---|---|---|---|
| Status | Number | Value between 100 - 200 | See Status Codes table. |
| Array { | |||
| linkId | Number | Value between 1 – 999999999 | Unique Identifier for the link. |
| forename | Alpha | a-z, A-Z, - 70 characters max | Forename of the subject at the matched link address. |
| middleName | Alpha | a-z, A-Z, - 35 characters max | Middle name 1 of the subject at the matched link address. |
| surname | Alpha | a-z, A-Z, - 35 characters max | Surname of the subject at the matched link address. |
| dob | Date | YYYY-MM-DD | DOB of the subject at the matched link address. If the DOB is not available 0000-00-00 will be returned. |
| age | Number | Value between -1 – 125 | Age of the subject at the matched link address. If the age is not available -1 will be returned.. |
| address1 | Alphanumeric | a-z, A-Z, 0-9, 64 characters max | When entering an address, postcode must be provided, and is the minimum value which can be entered. An address (full or partial) must be provided with every request. |
| address2 | Alphanumeric | a-z, A-Z, 0-9, 64 characters max | As Above |
| address3 | Alphanumeric | a-z, A-Z, 0-9, 64 characters max | As Above |
| address4 | Alphanumeric | a-z, A-Z, 0-9, 64 characters max | As Above |
| address5 | Alphanumeric | a-z, A-Z, 0-9, 64 characters max | As Above |
| postcode | Alphanumeric | a-z, A-Z, 0-9, - 8 characters max | Postcode |
| type | Alpha | Subject – Previous Subject – Forwarding Associate – Previous Associate – Forwarding Other – Previous Other – Forwarding Subject DOB |
The type of link found |
| distance | Number | 0 - 1000 | Distance in miles between the input address and the link address. |
| resScore | Alpha | Very Low Low Medium High Very High |
Residency Score. |
| } |
Once you receive a response, you can then present/use these values to suit your business needs.
Terms and conditions apply