Get Person By ID

GET /mpi/v1/person/{id}

Given a Person ID, this retrieves the person’s BMPI metadata and the collection of records grouped with that individual.

Path Parameters

id string

id of the person to fetch

Response Data

id string

The stable identifier for this person used across records (“Person ID”).

records collection

The constituent records that represent this person.

records.source string

A source system with an internal means of identifying individuals.

records.identifier string

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.

version integer

The BMPI version of the person. As records are added or removed, this number will be incremented.

status object
status.code string

One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).

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.