API reference · Identity & onboarding

Identifications

POST/accountholder/{type}/{value}/identificationAdd an identification document to an account holder
GET/accountholder/{type}/{value}/identificationsList identification documents for an account holder
GET/identification/{id}Fetch an identification document by reference
PUT/identification/{id}Update an identification document
POST/identification/{id}/document/{side}Upload a front/back document image for an identification
GET/identification/{id}/document/{side}/urlFetch a short-lived download URL for an identification's front/back document

POST Add an identification document to an account holder

POST /accountholder/{type}/{value}/identification

Registers an unverified identification document.

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: IdentificationRequest · Response: IdentificationResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/identification" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "identificationType": "PASSPORT",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "issuingAuthority": "Ada Obi",
    "issueDate": "2027-03-14",
    "expiryDate": "2027-03-14",
    "identifier": "identification number",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier"
  }'

{
  "identificationType": "PASSPORT",
  "identificationNumber": "identification number",
  "issuingCountryCode": "NG",
  "issuingAuthority": "Ada Obi",
  "issueDate": "2027-03-14",
  "expiryDate": "2027-03-14",
  "identifier": "identification number",
  "frontImageUrl": "unified resource identifier",
  "backImageUrl": "unified resource identifier"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "identificationType": "PASSPORT",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "issuingAuthority": "Ada Obi",
    "issueDate": "2027-03-14",
    "expiryDate": "2027-03-14",
    "identifier": "identification number",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Add an identification document to an account holder"
}

Responses

Status	When
`200`	Identification created successfully

GET List identification documents for an account holder

GET /accountholder/{type}/{value}/identifications

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: List<IdentificationResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "identificationType": "PASSPORT",
      "identificationNumber": "identification number",
      "issuingCountryCode": "NG",
      "issuingAuthority": "Ada Obi",
      "issueDate": "2027-03-14",
      "expiryDate": "2027-03-14",
      "identifier": "identification number",
      "verificationStatus": "PENDING",
      "verificationMethod": "verification method",
      "frontImageUrl": "unified resource identifier",
      "backImageUrl": "unified resource identifier",
      "rejectionReason": "March payroll"
    }
  ],
  "description": "List identification documents for an account holder"
}

Responses

Status	When
`200`	Identifications fetched successfully

GET Fetch an identification document by reference

GET /identification/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: IdentificationResponse

curl -X GET "https://api.bridgemoni.com/identification/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",
    "identificationType": "PASSPORT",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "issuingAuthority": "Ada Obi",
    "issueDate": "2027-03-14",
    "expiryDate": "2027-03-14",
    "identifier": "identification number",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Fetch an identification document by reference"
}

Responses

Status	When
`200`	Identification fetched successfully
`404`	No identification exists for the given reference

PUT Update an identification document

PUT /identification/{id}

Partially updates an identification document. 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: UpdateIdentificationRequest · Response: IdentificationResponse

curl -X PUT "https://api.bridgemoni.com/identification/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 '{
    "identificationType": "PASSPORT",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "issuingAuthority": "Ada Obi",
    "issueDate": "2027-03-14",
    "expiryDate": "2027-03-14",
    "identifier": "identification number",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier"
  }'

{
  "identificationType": "PASSPORT",
  "identificationNumber": "identification number",
  "issuingCountryCode": "NG",
  "issuingAuthority": "Ada Obi",
  "issueDate": "2027-03-14",
  "expiryDate": "2027-03-14",
  "identifier": "identification number",
  "frontImageUrl": "unified resource identifier",
  "backImageUrl": "unified resource identifier"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "identificationType": "PASSPORT",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "issuingAuthority": "Ada Obi",
    "issueDate": "2027-03-14",
    "expiryDate": "2027-03-14",
    "identifier": "identification number",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Update an identification document"
}

Responses

Status	When
`200`	Identification updated successfully
`404`	No identification exists for the given reference

POST Upload a front/back document image for an identification

POST /identification/{id}/document/{side}

Stores the uploaded file via the document module and attaches its reference to the identification's front or back side.

Headers

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

Path parameters

Name
`id`
`side`

Query parameters

Name	Default
`file`	Optional

Example

Response: IdentificationResponse

curl -X POST "https://api.bridgemoni.com/identification/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/document/FRONT?file=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/document.png"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "identificationType": "PASSPORT",
    "identificationNumber": "identification number",
    "issuingCountryCode": "NG",
    "issuingAuthority": "Ada Obi",
    "issueDate": "2027-03-14",
    "expiryDate": "2027-03-14",
    "identifier": "identification number",
    "verificationStatus": "PENDING",
    "verificationMethod": "verification method",
    "frontImageUrl": "unified resource identifier",
    "backImageUrl": "unified resource identifier",
    "rejectionReason": "March payroll"
  },
  "description": "Upload a front/back document image for an identification"
}

Responses

Status	When
`200`	Document uploaded successfully
`404`	No identification exists for the given reference

GET Fetch a short-lived download URL for an identification's front/back document

GET /identification/{id}/document/{side}/url

Returns a presigned URL (valid for a limited time) for the requested side.

Headers

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

Path parameters

Name
`id`
`side`

Example

Response: String

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

{
  "data": "text",
  "description": "Fetch a short-lived download URL for an identification's front/back document"
}

Responses

Status	When
`200`	Document URL fetched successfully
`404`	No document has been uploaded for this side yet

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