API Docs / Schemas / MatchContactsRequest

MatchContactsRequest

Request DTO for asking which of a batch of people the practice already holds as contacts.

Properties

Name Type Description
people*array of MatchContactsPersonRequest

The people to look up. Typically a company's officers and PSCs, straight off the
Companies House register.

The people to look up. Typically a company's officers and PSCs, straight off the
Companies House register.

JSON Example

{
  "people": [
    {
      "reference": "...",
      "firstName": "...",
      "lastName": "...",
      "companiesHouseOfficerId": "...",
      "dateOfBirth": "..."
    }
  ]
}

Used By Operations