Person Match

The Person Match action is one of the primary services within the Investigate Open API.

This action enables you to submit available information about a data subject and link these details with other actions such as Credit Linked Addresses and County Court Judgments.

Minimum Requirements

The Person Match request requires inputs of Name, Address, Contact and Other, which are defined in: People Search.

Service Request

To request for a Person match, add a PERSON_MATCH action to the request body entity PeopleActionsRequest:

{
    "actions": [
        { "action": "PERSON_MATCH" }
    ]
}

PeopleActionsRequest

	Array of objects (PersonAction) Actions to run with the given criteria
	object (PersonRequest) Person format used across the Investigate API
	object (Address) Address format used across the Investigate API
cohabitants	Array of strings (Cohabitants) Cohabitants at given address
sourceYears	Array of integers <int32> (SourceYears) [ items <int32 > ] Years when the matching datasets stored by GBG were issued. This could support customers compliance requirements.
tags	Array of strings Free text tags for tracking purposes.

{

• "actions": [

  • {

    • "action": "EMAIL_VERIFICATION"

    }

  ],
• "person": {

  • "firstName": "string",
  • "middleNames": [

    • "James"

    ],
  • "lastNames": [

    • "Smith"

    ],
  • "dateOfBirth": {

    • "day": 31,
    • "month": 12,
    • "year": 1981

    },
  • "gender": "U",
  • "phones": [

    • "+44 207 4281250"

    ],
  • "emails": [

    • "investigate@gbgplc.com"

    ],
  • "ageBand": {

    • "min": 31,
    • "max": 32

    }

  },
• "address": {

  • "premise": "128",
  • "building": "string",
  • "subBuilding": "string",
  • "thoroughfare": "Queen Victoria Street",
  • "locality": "London",
  • "postalCode": "EC4V 4BJ",
  • "country": "GBR"

  },
• "cohabitants": [

  • "John",
  • "Rita M Brown",
  • "Mary Williams"

  ],
• "sourceYears": [

  • 2021,
  • 2022

  ],
• "tags": [

  • "CASE_NUMBER=123",
  • "IMPORTANT"

  ]

}

Service Response

As part of the PersonActionsResponse entity, the property personMatch contains the results of the request.

PersonMatchActionResponse

	Array of objects (PersonMatch)
	object (Meta) Metadata describing the response produced.

{

• "matches": [

  • {

    • "matchId": "P_1955F18491918",
    • "person": {

      • "firstName": "string",
      • "middleNames": [

        • "James"

        ],
      • "lastNames": [

        • "Smith"

        ],
      • "dateOfBirth": {

        • "day": 31,
        • "month": 12,
        • "year": 1981

        },
      • "gender": "string",
      • "phones": [

        • "+44 207 4281250"

        ],
      • "emails": [

        • "investigate@gbgplc.com"

        ],
      • "ageBand": {

        • "min": 31,
        • "max": 32

        }

      },
    • "addresses": [

      • {

        • "premise": "128",
        • "building": "string",
        • "subBuilding": "string",
        • "thoroughfare": "Queen Victoria Street",
        • "locality": "London",
        • "postalCode": "EC4V 4BJ",
        • "country": "GBR",
        • "moveInDate": {

          • "day": 31,
          • "month": 12,
          • "year": 1981

          },
        • "moveOutDate": {

          • "day": 31,
          • "month": 12,
          • "year": 1981

          },
        • "cohabitants": [

          • "John",
          • "Rita M Brown",
          • "Mary Williams"

          ],
        • "hasMortalityRecord": true,
        • "hasInsolvencyRecord": true,
        • "hasGoneawayRecord": true

        }

      ],
    • "sources": [

      • {

        • "name": "string",
        • "years": [

          • 2018

          ]

        }

      ]

    }

  ],
• "meta": {

  • "traceId": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
  • "timestamp": "2019-01-04T14:38:25Z",
  • "investigationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFjZUlkIjoiMTIzNDU2IiwibWF0Y2hJZHMiOltdLCJleHAiOjE1MTYyMzkwMjJ9.3SZoV56G0HT289QqP04OT5F1ITtsMqRCGkPok2-st50"

  }

}