API reference · Identity & onboarding

Biometrics

POST/accountholder/{type}/{value}/biometricEnrol a biometric
POST/accountholder/{type}/{value}/biometric/livenessRecord a liveness check
POST/accountholder/{type}/{value}/biometric/matchMatch against an enrolled biometric
GET/accountholder/{type}/{value}/biometricsList an account holder's biometric enrolments
GET/biometric/{id}Fetch one biometric enrolment
PUT/biometric/{id}Revoke or supersede a biometric enrolment

POST Enrol a biometric

POST /accountholder/{type}/{value}/biometric

Records that a template exists and where it is held - PLATFORM or DEVICE. The template itself and the raw sample are never sent here and have no column in 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: BiometricEnrolmentRequest · Response: GenericResponseBiometricEnrolmentResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/biometric" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "modality": "FACE",
  "fingerPosition": "RIGHT_INDEX",
  "custody": "PLATFORM",
  "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "templateData": "string",
  "templateReference": "7fd2c8a1-0b44-4e2f-9c31-a7d5e1f30b62",
  "templateFormat": "ISO_19794_5",
  "templateVersion": 3,
  "qualityScore": 91,
  "enrolmentMethod": "LIVENESS_CAPTURE"
}'

{
  "modality": "FACE",
  "fingerPosition": "RIGHT_INDEX",
  "custody": "PLATFORM",
  "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "templateData": "string",
  "templateReference": "7fd2c8a1-0b44-4e2f-9c31-a7d5e1f30b62",
  "templateFormat": "ISO_19794_5",
  "templateVersion": 3,
  "qualityScore": 91,
  "enrolmentMethod": "LIVENESS_CAPTURE"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "modality": "FACE",
    "fingerPosition": "RIGHT_THUMB",
    "custody": "PLATFORM",
    "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "templateFormat": "ISO_19794_5",
    "templateVersion": "1",
    "qualityScore": "1",
    "enrolledDateTime": "2026-09-25T10:00:00Z",
    "enrolmentMethod": "LIVENESS_CAPTURE",
    "lastMatchedDateTime": "2026-09-25T10:00:00Z",
    "matchCount": "1",
    "enrolmentStatus": "ACTIVE",
    "lastMatchOutcome": "MATCH",
    "assuranceGrade": "BIO",
    "verificationStatus": "VERIFIED",
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Biometric enrolled successfully"
}

Responses

Status	When
`200`	Biometric enrolled successfully

POST Record a liveness check

POST /accountholder/{type}/{value}/biometric/liveness

Records whether a capture proved a live person was present.

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: LivenessCheckRequest · Response: GenericResponseLivenessCheckResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/biometric/liveness" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "modality": "FACE",
  "passed": "true",
  "providerCode": {
    "name": "string"
  },
  "confidenceScore": "1",
  "challengeType": "BLINK",
  "sessionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "modality": "FACE",
  "passed": "true",
  "providerCode": {
    "name": "string"
  },
  "confidenceScore": "1",
  "challengeType": "BLINK",
  "sessionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "checkedDateTime": "2026-09-25T10:00:00Z",
    "modality": "FACE",
    "passed": "true",
    "providerCode": {
      "name": "string"
    },
    "confidenceScore": "1",
    "challengeType": "BLINK"
  },
  "description": "Liveness check recorded successfully"
}

Responses

Status	When
`200`	Liveness check recorded successfully

POST Match against an enrolled biometric

POST /accountholder/{type}/{value}/biometric/match

Routes by custody - a platform-held template is compared by the matcher, a device-held one by verifying a signed assertion. A matcher that cannot answer returns UNKNOWN, never NO_MATCH.

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: BiometricMatchRequest · Response: GenericResponseBiometricMatchResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/biometric/match" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "modality": "FACE",
  "probeTemplateData": "string",
  "probeTemplateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "challenge": "string",
  "signedAssertion": "string"
}'

{
  "modality": "FACE",
  "probeTemplateData": "string",
  "probeTemplateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "challenge": "string",
  "signedAssertion": "string"
}

{
  "data": {
    "modality": "FACE",
    "outcome": "MATCH",
    "answer": "TRUE"
  },
  "description": "Biometric matched successfully"
}

Responses

Status	When
`200`	Biometric matched successfully

GET List an account holder's biometric enrolments

GET /accountholder/{type}/{value}/biometrics

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListBiometricEnrolmentResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "modality": "FACE",
      "fingerPosition": "RIGHT_THUMB",
      "custody": "PLATFORM",
      "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "templateFormat": "ISO_19794_5",
      "templateVersion": "1",
      "qualityScore": "1",
      "enrolledDateTime": "2026-09-25T10:00:00Z",
      "enrolmentMethod": "LIVENESS_CAPTURE",
      "lastMatchedDateTime": "2026-09-25T10:00:00Z",
      "matchCount": "1",
      "enrolmentStatus": "ACTIVE",
      "lastMatchOutcome": "MATCH",
      "assuranceGrade": "BIO",
      "verificationStatus": "VERIFIED",
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Biometric enrolments fetched successfully"
}

Responses

Status	When
`200`	Biometric enrolments fetched successfully

GET Fetch one biometric enrolment

GET /biometric/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseBiometricEnrolmentResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "modality": "FACE",
    "fingerPosition": "RIGHT_THUMB",
    "custody": "PLATFORM",
    "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "templateFormat": "ISO_19794_5",
    "templateVersion": "1",
    "qualityScore": "1",
    "enrolledDateTime": "2026-09-25T10:00:00Z",
    "enrolmentMethod": "LIVENESS_CAPTURE",
    "lastMatchedDateTime": "2026-09-25T10:00:00Z",
    "matchCount": "1",
    "enrolmentStatus": "ACTIVE",
    "lastMatchOutcome": "MATCH",
    "assuranceGrade": "BIO",
    "verificationStatus": "VERIFIED",
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Biometric enrolment fetched successfully"
}

Responses

Status	When
`200`	Biometric enrolment fetched successfully

PUT Revoke or supersede a biometric enrolment

PUT /biometric/{id}

Headers

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

Path parameters

Name
`id`

Example

Request body: UpdateBiometricEnrolmentRequest · Response: GenericResponseBiometricEnrolmentResponse

curl -X PUT "https://api.bridgemoni.com/biometric/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "enrolmentStatus": "REVOKED"
}'

{
  "enrolmentStatus": "REVOKED"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "modality": "FACE",
    "fingerPosition": "RIGHT_THUMB",
    "custody": "PLATFORM",
    "deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "templateFormat": "ISO_19794_5",
    "templateVersion": "1",
    "qualityScore": "1",
    "enrolledDateTime": "2026-09-25T10:00:00Z",
    "enrolmentMethod": "LIVENESS_CAPTURE",
    "lastMatchedDateTime": "2026-09-25T10:00:00Z",
    "matchCount": "1",
    "enrolmentStatus": "ACTIVE",
    "lastMatchOutcome": "MATCH",
    "assuranceGrade": "BIO",
    "verificationStatus": "VERIFIED",
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Biometric enrolment updated successfully"
}

Responses

Status	When
`200`	Biometric enrolment updated successfully

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