Add or Update Record (Blinded)
POST /mpi/v1/blindedRecord/{source}/{identifier}
Adds a new record or updates a previously created one in privacy-preserving (blinded) mode. Returns the record’s assigned person ID, along with any changes resulting from the addition or update.
To use this method you must have a local hashing service installed and use the hash demographics operation to get the hashed data. See Privacy-Preserving (Blinded) Mode for details.
Note
Partial updates are not supported; an update will completely replace the existing record. See
Understanding Matching for details.
Path Parameters
source
string
The system from which the record demographics were sourced.
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.
Body Data
Response Data
matchedPerson
object
The primary person matched in this operation.
matchedPerson.id
string
The stable identifier for this person used across records (“Person ID”).
matchedPerson.records
collection
The constituent records that represent this person.
matchedPerson.records.source
string
A source system with an internal means of identifying individuals.
matchedPerson.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.
matchedPerson.version
integer
As records are added or removed, this version number will be incremented.
matchedPerson.status
object
Child Fields
matchedPerson.status.code
string
One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).
matchedPerson.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.
changedPersons
collection
Other persons that were changed in the process of adding/updating this record.
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.