Add Match Guidance
POST /mpi/v1/addGuidance
Overrides automatic matching with manual guidance for a particular set of records. This should be used when it is known that two records represent the same or different individuals.
Note
Manual guidance will last until it is removed by the
Remove Match Guidance operation. The system will never use its matching rules to automatically unlink a manual match or link records that have been manually specified as “no match”.
Body Data
recordOne
object
+ Child Fields
recordOne.source
string
A source system with an internal means of identifying individuals.
recordOne.identifier
string
The unique identifier of the record within the source. This will be stored directly in the Identity service (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
recordTwo
object
+ Child Fields
recordTwo.source
string
A source system with an internal means of identifying individuals.
recordTwo.identifier
string
The unique identifier of the record within the source. This will be stored directly in the Identity service (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
action
string
Use Match if the two records represent the same individual, and NoMatch if the two records represent different individuals.
comment
string
A comment for documentation/audit purposes.
Response Data
changedPersons
collection
List of persons changed by the operation.
changedPersons.id
string
The stable identifier for this person used across records (“Person ID”).
changedPersons.records
collection
The constituent records that represent this person.
changedPersons.records.source
string
A source system with an internal means of identifying individuals.
changedPersons.records.identifier
string
The unique identifier of the record within the source. This will be stored directly in the Identity service (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
changedPersons.version
integer
As records are added or removed, this version number will be incremented.
changedPersons.status
object
+ Child Fields
changedPersons.status.code
string
One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).
changedPersons.status.supercededBy
collection<string
If the person’s constituent records were merged into another person, this will contain the id for that person.
If the person’s constituent records were split into two or more persons, this will contain the ids for those persons.