Parameters
| Parameter | Type | Format | Description |
|---|---|---|---|
| Addresses | Array | Array of ValidIdSmartlinkAddressResult, see below |
ValidIdSmartlinkAddressResult
| Parameter | Type | Format | Description |
|---|---|---|---|
| Title | String | Title of the subject in the matched record | |
| Forename | String | Forename of the subject in the matched record | |
| MiddleName | String | Middle name or middle initial of the subject in the matched record | |
| Surname | String | Surname of the subject in the matched record | |
| DOB | DateTime | ISO 8601 | Date of birth of the subject in the matched record |
| Address1 | String | Address line 1 of the matched record | |
| Address2 | String | ||
| Address3 | String | ||
| Address4 | String | ||
| Address5 | String | ||
| PostCode | String | Postcode of the matched record | |
| DeliveryPointSuffix | String | Delivery Point Suffix (DPS) of the matched record | |
| Recency | DateTime | ISO 8601 | Date of the matched record (nullable) |
| Residency | String | Year matched record highlights the subject as having first resided at the linked address | |
| LinkSource | String | Source of the Smartlink, see the data flags section below |
Link source flags
| Flag | Description |
|---|---|
| F | Forwarding Address |
| P | Previous Address |
| D | Name and Date of Birth link to an alternative address |