Using the API
Frequently Asked Questions
Tutorials
BMPI Operations
- Add or Update Record
- Add or Update Record (Blinded)
- Get Person by Record
- Get Person by ID
- Match Demographics
- Match Demographics (Blinded)
- Delete Record
- Add Match Guidance
- Remove Match Guidance
Local Hashing Service
Metrics
Remove Match Guidance
POST /mpi/v1/removeGuidance
Removes a previously-created manual match guidance.
Contents
Body Data
The first record.
A source system with an internal means of identifying individuals.
The unique identifier of the record within the source. This will be stored directly in the BMPI (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
The second record.
A source system with an internal means of identifying individuals.
The unique identifier of the record within the source. This will be stored directly in the BMPI (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
A comment for documentation/audit purposes.
Response Data
List of persons changed by the operation.
The stable identifier for this person used across records (“Person ID”).
The constituent records that represent this person.
A source system with an internal means of identifying individuals.
The unique identifier of the record within the source. This will be stored directly in the BMPI (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
The BMPI version of the person. As records are added or removed, this number will be incremented.
One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).
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.
