API REFERENCE · SCHEMA

MatchAssessment schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Retained name similarity, identity comparison states and review evidence tier. Contains no copied subject values. Missing information, conflicts and partial dates remain distinct; an evidence tier is not a finding of identity or wrongdoing.

nameRequired
object or null

May be null.

name fields and rules

Allowed alternatives

  • Provide name.similarity and name.method and name.aliasKind and name.aliasQuality.
    name.similarityRequired
    integer

    Minimum: 0. Maximum: 100.

    name.methodRequired
    string
    name.aliasKindRequired
    string

    Values: "primary", "alias".

    name.aliasQualityRequired
    string

    Values: "strong", "weak", "unknown".

    Additional fields are not accepted.

  • null

    May be null.

identifiersRequired
object
identifiers fields and rules
identifiers.statusRequired
string

Values: "agreement", "conflict", "not_supplied", "unavailable", "not_comparable".

identifiers.matchedRequired
integer

Minimum: 0. Maximum: 9007199254740991.

identifiers.issuerAgreementsRequired
integer

Minimum: 0. Maximum: 9007199254740991.

identifiers.issuerUnknownRequired
integer

Minimum: 0. Maximum: 9007199254740991.

identifiers.conflictsRequired
integer

Minimum: 0. Maximum: 9007199254740991.

Additional fields are not accepted.

birthDateRequired
object
birthDate fields and rules
birthDate.statusRequired
string

Values: "agreement", "conflict", "not_supplied", "unavailable", "not_comparable".

birthDate.precisionOptional
string

Values: "year", "month", "day".

Additional fields are not accepted.

countryRequired
object
country fields and rules
country.statusRequired
string

Values: "agreement", "conflict", "not_supplied", "unavailable", "not_comparable".

Additional fields are not accepted.

entityTypeRequired
object
entityType fields and rules
entityType.statusRequired
string

Values: "agreement", "conflict", "not_supplied", "unavailable", "not_comparable".

Additional fields are not accepted.

reviewTierRequired
string

Values: "identifier", "corroborated", "conflicting", "name_only".

alertBasisRequired
string

Values: "identifier", "name", "name_and_birth_date", "partial_name".

hasConflictsRequired
boolean
sameNameCandidatesRequired
integer

Minimum: 0. Maximum: 9007199254740991.

Additional fields are not accepted.

Use MatchAssessment in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides