API reference · Identity & onboarding

PediID Subjects

POST Resolve a PIID to your own pairwise identifier

POST /id/resolve

Maps a PIID a customer has quoted to the pairwise identifier THIS integrator holds for that person, and nothing else. It returns no name, no attribute and no other integrator's identifier, so it cannot be used to look somebody up - only to recognise a person you already have a relationship with. The response is deliberately useless to anybody who is not already storing that pairwise identifier. It is bounded per caller, and a lookup that finds nobody costs ten times one that succeeds: a run of misses is what enumeration looks like, a run of hits is what a support desk looks like. A malformed PIID is refused before any of that, on its check digit alone, and costs nothing - the check digit is a public algorithm, so telling a caller they mistyped reveals nothing they could not compute themselves.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Example

Request body: ResolvePiidRequest · Response: GenericResponseResolvePiidResponse

curl -X POST "https://api.bridgemoni.com/id/resolve" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "piid": "string"
}'

Responses

StatusWhen
200The caller's own pairwise identifier
400Not sixteen digits, or the check digit does not match
404No subject holds that PIID. Knowing a PIID grants nothing on its own, so this is the same answer whether the PIID was never issued or is simply not one this caller can see.
429Too many lookups from this caller

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors