Consumer Search Endpoints
The consumer search is shared with AML search. AML search will be detailed separately. The endpoints here are available for consumer searches.
- Authenticate
- Return search reasons
- Submit a consumer search
- Resolve a picklist
- View search history request
- View search history
- Set a reference for a historic item
- Revalidate a search with additional information
Flow Diagram
1. Authenticate
Before using any of the endpoints, you must authenticate. This ensures you have the necessary permissions to access the data.
Example Request
POST /authenticate2. Submit A Consumer Search
This endpoint is used to submit a consumer search. The outcome depends on the search results:
Single Match: If the submitted information results in one unique match, a consumer report will be generated in the response.
Multiple Matches: If multiple potential matches are found, the pickList property will be returned instead of the consumer report. You will need to review the options in the pickList and use the Resolve Picklist endpoint to select the correct match and generate the consumer report.
Example Request
POST localSolutions/GB/identitysearchExample RequestBody (Single Hit)
{
"common": {
"person": {
"currentName": {
"title": "Miss",
"forename": "Anne",
"otherNames": "",
"surname": "Delta",
"suffix": ""
},
"previousName": {
"title": "Miss",
"forename": "Anne",
"otherNames": "",
"surname": "Alpha",
"suffix": ""
},
"dateOfBirth": "1948-06-04",
"gender": "Female",
"addresses": {
"current": {
"buildingNo": "7",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13",
"endDate": ""
},
"previous1": {
"buildingNo": "6",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2012-05-08",
"endDate": "2013-05-08"
},
"previous2": {
"buildingNo": "1",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13",
"endDate": "2012-05-08"
}
}
},
"reference": "Test - Consumer Search"
},
"reference": "Test - Consumer Search",
"consumer": {
"reason": "QuotationSearch",
"thirdPartyOptIn": "False"
},
"products": [
"Consumer"
]
}Response Object (Single Hit)
The consumerResult property has been shown but not populated. Please see the API Documentation for the example response structure.
{
"correlationId": "ac97f434-a649-4943-a62b-dca9723cedd8",
"uniqueId": "a7fdab3a94184e3abda78abb1ae195e1",
"input": {
"uniqueId": "a7fdab3a94184e3abda78abb1ae195e1",
"common": {
"person": {
"currentName": {
"title": "Miss",
"forename": "Anne",
"otherNames": "",
"surname": "Delta",
"suffix": ""
},
"previousName": {
"title": "Miss",
"forename": "Anne",
"otherNames": "",
"surname": "Alpha",
"suffix": ""
},
"dateOfBirth": "1948-06-04T00:00:00",
"gender": "Female",
"addresses": {
"current": {
"buildingNo": "7",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13T00:00:00"
},
"previous1": {
"buildingNo": "6",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2012-05-08T00:00:00",
"endDate": "2013-05-08T00:00:00"
},
"previous2": {
"buildingNo": "1",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13T00:00:00",
"endDate": "2012-05-08T00:00:00"
}
}
},
"customerId": 123456789,
"userId": 123456789,
"reference": "Test - Consumer Search"
},
"consumer": {
"reason": "QuotationSearch",
"thirdPartyOptIn": false,
"addressLink": false,
"associateLink": false
},
"products": [
"Consumer"
]
},
"common": {
"customerId": 123456789,
"userId": 123456789,
"uniqueId": "a7fdab3a94184e3abda78abb1ae195e1",
"searchText": "Miss Anne Delta (4/06/1948) X9 8JD",
"reference": "Test - Consumer Search",
"searchTime": "2025-04-25T19:14:03.6067519+00:00"
},
"consumerResult": {
},
"errors": {}
}Example RequestBody (Multiple Hits)
{
"common": {
"person": {
"currentName": {
"title": "Mr ",
"forename": "Henry",
"otherNames": "",
"surname": "Bulldog",
"suffix": ""
},
"previousName": {
"title": "",
"forename": "",
"otherNames": "",
"surname": "",
"suffix": ""
},
"dateOfBirth": "1960-07-01",
"gender": "Male",
"addresses": {
"current": {
"buildingNo": "",
"buildingName": "",
"street": "",
"city": "",
"postCode": "X9 9TA",
"startDate": "",
"endDate": ""
},
"previous1":{
"buildingNo": "",
"buildingName": "",
"street": "",
"city": "",
"postCode": "",
"startDate": "",
"endDate": ""
},
"previous2":{
"buildingNo": "",
"buildingName": "",
"street": "",
"city": "",
"postCode": "",
"startDate": "",
"endDate": ""
}
}
},
"reference": "Test - Consumer Search"
},
"consumer":{
"reason": "QuotationSearch",
"thirdPartyOptIn": "False"
},
"products": [
"consumer"
]
}Response Object (Multiple Hits)
The consumerResult property has been omitted here due to multiple results. The property pickList has taken its place that will require to be actioned.
{
"correlationId": "b1df1ecf-7e2b-44de-a78f-69109d1d67fc",
"uniqueId": "35e11f3693db4a24920da6a8d4559437",
"input": {
"uniqueId": "35e11f3693db4a24920da6a8d4559437",
"common": {
"person": {
"currentName": {
"title": "Mr ",
"forename": "Henry",
"otherNames": "",
"surname": "Bulldog",
"suffix": ""
},
"previousName": {
"title": "",
"forename": "",
"otherNames": "",
"surname": "",
"suffix": ""
},
"dateOfBirth": "1960-07-01T00:00:00",
"gender": "Male",
"addresses": {
"current": {
"buildingNo": "",
"buildingName": "",
"street": "",
"city": "",
"postCode": "X9 9TA"
},
"previous1": {
"buildingNo": "6",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2012-05-08T00:00:00",
"endDate": "2013-05-08T00:00:00"
},
"previous2": {
"buildingNo": "1",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2013-05-08T00:00:00"
}
}
},
"customerId": 123456789,
"userId": 123456789,
"reference": "Test - Consumer Search"
},
"consumer": {
"noOfAddresses": 2,
"reason": "QuotationSearch",
"thirdPartyOptIn": false,
"addressLink": false,
"associateLink": false
},
"products": [
"Consumer"
]
},
"common": {
"customerId": 123456789,
"userId": 123456789,
"uniqueId": "35e11f3693db4a24920da6a8d4559437",
"searchText": "Mr Henry Bulldog (1/07/1960) X9 9TA",
"reference": "Test - Consumer Search",
"searchTime": "2025-04-16T10:10:40.9539703+00:00"
},
"picklist": [
{
"type": "Name",
"applicantId": 1,
"address": "Current Address",
"name": "Current Name",
"inputs": {
"name": "Mr Henry Bulldog"
},
"options": [
{
"option": "1:1:1_0",
"value": "MR HENRY BULLDOG",
"dateOfBirth": "01/07/1960"
},
{
"option": "1:1:1_1",
"value": "MR HENRY P BULLDOG",
"dateOfBirth": "01/07/1960"
},
{
"option": "1:1_999",
"value": "None of the above"
}
]
}
],
"errors": {}
}3. Resolve A Picklist
When a pickList is returned in the response, this endpoint must be used to select the correct match and retrieve the consumer report.
How It Works
- Review the options array in the pickList property to identify the potential matches.
- Select the appropriate option that corresponds to the correct match.
- Submit the selected option to this endpoint to process the request and generate the consumer report.
Example Request
PUT localSolutions/GB/identitysearch- The uniqueId must be included in the request path. This uniqueId is obtained from the response of the previous endpoint.
Example RequestBody
[
"1:1:1_0"
]Example Response
The response will include the consumer report for the selected option. Refer to the API documentation for the full response structure.
The `consumerResult` property has been shown but not populated. Please see the API Documentation for the example response structure.
```http
{
"correlationId": "ac97f434-a649-4943-a62b-dca9723cedd8",
"uniqueId": "a7fdab3a94184e3abda78abb1ae195e1",
"input": {
"uniqueId": "a7fdab3a94184e3abda78abb1ae195e1",
"common": {
"person": {
"currentName": {
"title": "Mr ",
"forename": "Henry",
"otherNames": "",
"surname": "Bulldog",
"suffix": ""
},
"previousName": {
"title": "",
"forename": "",
"otherNames": "",
"surname": "",
"suffix": ""
},
"dateOfBirth": "1960-07-01T00:00:00",
"gender": "Male",
"addresses": {
"current": {
"buildingNo": "",
"buildingName": "",
"street": "",
"city": "",
"postCode": "X9 9TA"
},
"previous1": {
"buildingNo": "6",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2012-05-08T00:00:00",
"endDate": "2013-05-08T00:00:00"
},
"previous2": {
"buildingNo": "1",
"buildingName": "",
"street": "Twelve Acre Cresent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2013-05-08T00:00:00"
}
}
},
"customerId": 123456789,
"userId": 123456789,
"reference": "Test - Consumer Search"
},
"consumer": {
"reason": "QuotationSearch",
"thirdPartyOptIn": false,
"addressLink": false,
"associateLink": false
},
"products": [
"Consumer"
]
},
"common": {
"customerId": 123456789,
"userId": 123456789,
"uniqueId": "a7fdab3a94184e3abda78abb1ae195e1",
"searchText": "Mr Henry Bulldog (01/07/1960) X9 9TA",
"reference": "Test - Consumer Search",
"searchTime": "2025-04-25T19:14:03.6067519+00:00"
},
"consumerResult": {
},
"errors": {}
}