API Docs / Schemas / MatchContactsPersonRequest

MatchContactsPersonRequest

One person to look for among the practice's existing contacts.

Properties

Name Type Description
reference*string

Caller's own identifier for this person, echoed back on the result so the answers can be
lined up with the list that was sent.

Caller's own identifier for this person, echoed back on the result so the answers can be
lined up with the list that was sent.

firstNamestring
lastNamestring
companiesHouseOfficerIdstring

Companies House's identifier for this person, when they came from the officer register.
The one signal that identifies somebody with certainty.

Companies House's identifier for this person, when they came from the officer register.
The one signal that identifies somebody with certainty.

dateOfBirthstring

The person's date of birth. Only the month and year are compared, so the partial date
Companies House publishes (day set to 1) is fine here.

The person's date of birth. Only the month and year are compared, so the partial date
Companies House publishes (day set to 1) is fine here.

JSON Example

{
  "reference": "string",
  "firstName": "string",
  "lastName": "string",
  "companiesHouseOfficerId": "string",
  "dateOfBirth": "2024-01-01"
}

Contained in Schemas