API reference · Identity & onboarding

Verification

POST/accountholder/{type}/{value}/verificationRecord a verification for an account holder
GET/accountholder/{type}/{value}/verificationsList verification records for an account holder
GET/verification/{id}Fetch a verification record by reference
PUT/verification/{id}Update a verification record

POST Record a verification for an account holder

POST /accountholder/{type}/{value}/verification

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: VerificationRequest · Response: VerificationResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/verification" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "assuranceLevel": 1,
    "verificationDateTime": "2027-03-14T14:30:01"
  }'

{
  "assuranceLevel": 1,
  "verificationDateTime": "2027-03-14T14:30:01"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "assuranceLevel": 1,
    "verificationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Record a verification for an account holder"
}

Responses

Status	When
`200`	Verification created successfully

GET List verification records for an account holder

GET /accountholder/{type}/{value}/verifications

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: List<VerificationResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "verificationStatus": "PENDING",
      "verificationMethod": "verification method",
      "assuranceLevel": 1,
      "verificationDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List verification records for an account holder"
}

Responses

Status	When
`200`	Verification records fetched successfully

GET Fetch a verification record by reference

GET /verification/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: VerificationResponse

curl -X GET "https://api.bridgemoni.com/verification/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",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "assuranceLevel": 1,
    "verificationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Fetch a verification record by reference"
}

Responses

Status	When
`200`	Verification fetched successfully
`404`	No verification record exists for the given reference

PUT Update a verification record

PUT /verification/{id}

Partially updates a verification record. Only non-null fields in the request body are applied.

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: UpdateVerificationRequest · Response: VerificationResponse

curl -X PUT "https://api.bridgemoni.com/verification/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 '{
    "assuranceLevel": 1,
    "verificationDateTime": "2027-03-14T14:30:01"
  }'

{
  "assuranceLevel": 1,
  "verificationDateTime": "2027-03-14T14:30:01"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "assuranceLevel": 1,
    "verificationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Update a verification record"
}

Responses

Status	When
`200`	Verification updated successfully
`404`	No verification record exists for the given reference

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