Submit A GB Consumer or AML Search

Request

Submits a GB Consumer or AML depending on the Product provided. Validates criteria for each individual search before submitting, and may return a list of error strings instead.

Security

bearerToken

Bodyapplication/json

Select the relevant tab for the request body for one of the products AML, AMLMultiBureau or Consumer.

NOTE:' If a previous address is used in addition to current the postCode becomes required.

One of:

Search parameters for AML product

commonobject(ConnectIdentityAmlCommonSearchCriteria)

Person search criteria

Example:

{
  "person": {
    "currentName": { … },
    "previousName"": { … },
    "dateOfBirth": "1991-04-05",
    "gender": "Male",
    "addresses": { … }
  },
  "reference": "24680"
}

idAmlobject

Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.

Example:

{
  "LandlineNumber": "",
  "ExDirectory": false,
  "Documents": null
}

productsArray of strings

Enter AML for this product search

Example:

[
  "AML"
]

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "common": {
      "person": {
        "currentName": {
          "title": "",
          "forename": "Doe",
          "otherNames": "",
          "surname": "John",
          "suffix": ""
        },
        "previousName\"": {
          "title": null,
          "forename": null,
          "otherName\"": null,
          "surname": null,
          "suffix": null
        },
        "dateOfBirth": "1991-04-05",
        "gender": "Male",
        "addresses": {
          "current": {
            "abodeNo": "",
            "buildingNo": "110",
            "buildingName": "",
            "street": "Pierhead Street",
            "subStreet": "",
            "city": "Cardiff",
            "postCode": "CF10 4DQ",
            "organisation": "",
            "subBuilding": "",
            "district": ""
          },
          "previous1": {
            "abodeNo": "",
            "buildingNo": "",
            "buildingName": "",
            "street": "",
            "subStreet": "",
            "city": "",
            "postCode": "",
            "organisation": "",
            "subBuilding": "",
            "district": ""
          },
          "previous2": {
            "abodeNo": "",
            "buildingNo": "",
            "buildingName": "",
            "street": "",
            "subStreet": "",
            "city": "",
            "postCode": "",
            "organisation": "",
            "subBuilding": "",
            "district": ""
          }
        }
      },
      "reference": "24680"
    },
    "idAml": {
      "LandlineNumber": "",
      "ExDirectory": false,
      "Documents": null
    },
    "products": [
      "AML"
    ],
    "uniqueId": null
  }'

Responses

Success

Bodyapplication/json

One of:

correlationIdstring

A unique identifier for tracking the request across systems.

Example:"a2093b41-b7fe-4973-8eba-78f3627168a7"

uniqueIdstring

A unique identifier for the specific search request.

Example:"43d27878fa4b4e74b336a6c1b21d690d"

inputobject

Contains the input parameters used for the search request.

commonobject

pickListArray of objects

A list of potential consumer results when more than one match is found.
This property will not appear if only one result is returned.

consumerResultobject

Contains the result of the consumer search when exactly one match is found. This property will not appear if multiple results are returned; in that case, the pickList property will be present instead.

errorsobject

Response

{
  "correlationId": "a2093b41-b7fe-4973-8eba-78f3627168a7",
  "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
  "input": {
    "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
    "common": { … },
    "consumer": { … },
    "products": [ … ]
  },
  "common": {
    "customerId": 106828872,
    "userId": 101686746,
    "uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
    "searchText": "Miss Anne Delta (4/06/1948) X9 8JD",
    "reference": "Test - Consumer Search",
    "searchTime": "024-04-23T11:19:35.180004+00:00"
  },
  "pickList": [
    { … }
  ],
  "consumerResult": {
    "applicant1Report": { … },
    "dateAndTimeOfReport": "2021-01-01T12:00:48",
    "gaugeVersion": "G1",
    "reason": "Quotation Search",
    "success": false,
    "supplierId": "{AAAAE42F-92E5-4ED9-B322-XXXXXXXXXXXX}",
    "creditsIncurred": 1
  },
  "errors": {}
}