API Docs / Schemas / ContactMatchResultDto

ContactMatchResultDto

The existing contacts that might be one person from a match request.

Properties

Name Type Description
referencestring

The reference the caller sent this person under.

The reference the caller sent this person under.

matchesarray of ContactMatchDto

Contacts that could be this person, most likely first. Empty when the practice does not
hold them. Contacts that positively contradict the person - a different Companies House
officer id, a different month of birth - are not listed at all.

Contacts that could be this person, most likely first. Empty when the practice does not
hold them. Contacts that positively contradict the person - a different Companies House
officer id, a different month of birth - are not listed at all.

JSON Example

{
  "reference": "string",
  "matches": [
    {
      "confidence": "...",
      "contact": "..."
    }
  ]
}