Execute Individual Search

Request

Executes a search using optional personal and address details.

Security

bearerToken

Bodyapplication/jsonrequired

firstNamestringrequired

First name of the individual.

middleNamestring

Middle name of the individual.

lastNamestringrequired

Last name of the individual.

dateOfBirthstring, (date)required

Date of birth of the individual.

Example:"YYYY-MM-DD"

reasonForSearchstringrequired

Reason for performing the search.

Enum:"AM""AV""BS""CA""DC""DS""EC""GI""QS""TV"

titlestring

Title of the individual.

addressesobjectrequired

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/verify/individual/directReport \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "YYYY-MM-DD",
    "reasonForSearch": "AM",
    "title": "string",
    "addresses": {
      "currentAddress": {
        "postCode": "string",
        "addressLine": "string",
        "buildingNo": "string",
        "buildingName": "string",
        "subBuilding": "string",
        "street": "string",
        "town": "string",
        "county": "string"
      },
      "previousAddresses": [
        {
          "position": 1,
          "postCode": "string",
          "addressLine": "string",
          "buildingNo": "string",
          "buildingName": "string",
          "subBuilding": "string",
          "street": "string",
          "town": "string",
          "county": "string"
        }
      ]
    }
  }'

Responses

Bodyapplication/json

verifyMatchboolean

Indicates if the verification matches (true if ANY address matched). Aggregated from all address results using OR logic.

flagsobject(Flags)

Top-level aggregated flags. Each flag is true if ANY address has the flag set to true (aggregated using OR logic). Always present in response.

directorshipsArray of objects

Company directorships for the individual. Always present in response (may be empty array). Only populated when PNR is matched and customer has Full (3136) backend flag. Ordered by appointment status: Current, then Resigned, then Dissolved.

addressesobject

Address verification results matching the request structure. Always present in response.

requestDetailsobject(PostSearchRequestDetails)

Response

{
  "verifyMatch": true,
  "flags": {
    "ccjMatch": true,
    "electoralRegisterMatch": true,
    "deceasedRegisterMatch": true,
    "insolvencyMatch": true
  },
  "directorships": [
    { … }
  ],
  "addresses": {
    "currentAddress": { … },
    "previousAddresses": { … }
  },
  "requestDetails": {
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "string",
    "reasonForSearch": "string",
    "buildingNo": "string",
    "buildingName": "string",
    "subBuilding": "string",
    "street": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "addressLine": "string",
    "addresses": { … }
  }
}