API reference · Identity & onboarding

Digital identity

POST/accountholder/{type}/{value}/deviceEnrol a device against an account holder
GET/accountholder/{type}/{value}/device/summarySummarise an account holder's enrolled devices
PUT/accountholder/{type}/{value}/device/{id}/revocationRevoke one of an account holder's enrolled devices
GET/accountholder/{type}/{value}/digital/identityFetch an account holder's digital identity
POST/accountholder/{type}/{value}/digital/identityRecord an account holder's digital identity
PUT/accountholder/{type}/{value}/digital/identityUpdate an account holder's digital identity

POST Enrol a device against an account holder

POST /accountholder/{type}/{value}/device

The response is a count and an assurance capability. No device identifier, binding key, model or platform is ever released by this module.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: DeviceEnrolmentRequest · Response: GenericResponseDeviceSummaryResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/device" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "bindingKeyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "platform": "IOS",
  "model": {
    "name": "string"
  },
  "osVersion": {
    "name": "string"
  },
  "aalCapability": "1",
  "hardwareBacked": "true"
}'

{
  "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "bindingKeyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "platform": "IOS",
  "model": {
    "name": "string"
  },
  "osVersion": {
    "name": "string"
  },
  "aalCapability": "1",
  "hardwareBacked": "true"
}

{
  "data": {
    "deviceCount": "1",
    "highestAalCapability": "1"
  },
  "description": "Device enrolled successfully"
}

Responses

Status	When
`200`	Device enrolled successfully

GET Summarise an account holder's enrolled devices

GET /accountholder/{type}/{value}/device/summary

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseDeviceSummaryResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/device/summary" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "deviceCount": "1",
    "highestAalCapability": "1"
  },
  "description": "Device summary fetched successfully"
}

Responses

Status	When
`200`	Device summary fetched successfully

PUT Revoke one of an account holder's enrolled devices

PUT /accountholder/{type}/{value}/device/{id}/revocation

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`
`id`

Example

Response: GenericResponseDeviceSummaryResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/value/value/device/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/revocation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "deviceCount": "1",
    "highestAalCapability": "1"
  },
  "description": "Device revoked successfully"
}

Responses

Status	When
`200`	Device revoked successfully

GET Fetch an account holder's digital identity

GET /accountholder/{type}/{value}/digital/identity

The authenticator assurance level reached on any one authentication is carried on that event, not here. Identity assurance is derived from the evidence chain and is never asserted by a caller.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseDigitalIdentityResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/digital/identity" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "pediid": "string",
    "username": "string",
    "did": "string",
    "didMethod": "string",
    "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountCreatedDateTime": "2026-09-25T10:00:00Z",
    "currentIal": "1",
    "highestIalAttained": "1",
    "ialAttainedDateTime": "2026-09-25T10:00:00Z",
    "recoveryConfigured": "true",
    "subjectStatus": "ACTIVE",
    "accountAgeDays": "1"
  },
  "description": "Digital identity fetched successfully"
}

Responses

Status	When
`200`	Digital identity fetched successfully

POST Record an account holder's digital identity

POST /accountholder/{type}/{value}/digital/identity

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: DigitalIdentityRequest · Response: GenericResponseDigitalIdentityResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/digital/identity" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "pediid": "string",
  "username": "string",
  "did": "string",
  "didMethod": "string",
  "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "accountCreatedDateTime": "2026-09-25T10:00:00Z",
  "currentIal": "1",
  "highestIalAttained": "1",
  "ialAttainedDateTime": "2026-09-25T10:00:00Z",
  "recoveryConfigured": "true",
  "subjectStatus": "ACTIVE"
}'

{
  "pediid": "string",
  "username": "string",
  "did": "string",
  "didMethod": "string",
  "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "accountCreatedDateTime": "2026-09-25T10:00:00Z",
  "currentIal": "1",
  "highestIalAttained": "1",
  "ialAttainedDateTime": "2026-09-25T10:00:00Z",
  "recoveryConfigured": "true",
  "subjectStatus": "ACTIVE"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "pediid": "string",
    "username": "string",
    "did": "string",
    "didMethod": "string",
    "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountCreatedDateTime": "2026-09-25T10:00:00Z",
    "currentIal": "1",
    "highestIalAttained": "1",
    "ialAttainedDateTime": "2026-09-25T10:00:00Z",
    "recoveryConfigured": "true",
    "subjectStatus": "ACTIVE",
    "accountAgeDays": "1"
  },
  "description": "Digital identity saved successfully"
}

Responses

Status	When
`200`	Digital identity saved successfully

PUT Update an account holder's digital identity

PUT /accountholder/{type}/{value}/digital/identity

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: DigitalIdentityRequest · Response: GenericResponseDigitalIdentityResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/value/value/digital/identity" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "pediid": "string",
  "username": "string",
  "did": "string",
  "didMethod": "string",
  "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "accountCreatedDateTime": "2026-09-25T10:00:00Z",
  "currentIal": "1",
  "highestIalAttained": "1",
  "ialAttainedDateTime": "2026-09-25T10:00:00Z",
  "recoveryConfigured": "true",
  "subjectStatus": "ACTIVE"
}'

{
  "pediid": "string",
  "username": "string",
  "did": "string",
  "didMethod": "string",
  "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "accountCreatedDateTime": "2026-09-25T10:00:00Z",
  "currentIal": "1",
  "highestIalAttained": "1",
  "ialAttainedDateTime": "2026-09-25T10:00:00Z",
  "recoveryConfigured": "true",
  "subjectStatus": "ACTIVE"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "pediid": "string",
    "username": "string",
    "did": "string",
    "didMethod": "string",
    "didDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountCreatedDateTime": "2026-09-25T10:00:00Z",
    "currentIal": "1",
    "highestIalAttained": "1",
    "ialAttainedDateTime": "2026-09-25T10:00:00Z",
    "recoveryConfigured": "true",
    "subjectStatus": "ACTIVE",
    "accountAgeDays": "1"
  },
  "description": "Digital identity updated successfully"
}

Responses

Status	When
`200`	Digital identity updated successfully

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