API reference · Identity & onboarding

Financial accounts

POST/accountholder/{type}/{value}/financial/accountRegister a financial account
GET/accountholder/{type}/{value}/financial/accountsList an account holder's records
GET/financial/account/{id}Fetch one record

POST Register a financial account

POST /accountholder/{type}/{value}/financial/account

The full account number is accepted here and never returned. Only a masked form and a keyed hash are kept, and the hash is what stops two people claiming the same account.

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: SubjectBankAccountRequest · Response: GenericResponseSubjectBankAccountResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/financial/account" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "institutionCode": "string",
  "institutionName": {
    "name": "string"
  },
  "institutionCountryCode": "string",
  "accountNumber": "string",
  "accountName": {
    "name": "string"
  },
  "accountType": "main",
  "currencyCode": "string",
  "primaryAccount": "true"
}'

{
  "institutionCode": "string",
  "institutionName": {
    "name": "string"
  },
  "institutionCountryCode": "string",
  "accountNumber": "string",
  "accountName": {
    "name": "string"
  },
  "accountType": "main",
  "currencyCode": "string",
  "primaryAccount": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "institutionCode": "string",
    "institutionName": {
      "name": "string"
    },
    "institutionCountryCode": "string",
    "accountNumberMasked": "string",
    "accountName": {
      "name": "string"
    },
    "accountType": "main",
    "currencyCode": "string",
    "nameMatchStatus": "EXACT",
    "nameMatchScore": "1",
    "primaryAccount": "true",
    "active": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Financial accounts created successfully"
}

Responses

Status	When
`200`	Financial accounts created successfully

GET List an account holder's records

GET /accountholder/{type}/{value}/financial/accounts

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListSubjectBankAccountResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "institutionCode": "string",
      "institutionName": {
        "name": "string"
      },
      "institutionCountryCode": "string",
      "accountNumberMasked": "string",
      "accountName": {
        "name": "string"
      },
      "accountType": "main",
      "currencyCode": "string",
      "nameMatchStatus": "EXACT",
      "nameMatchScore": "1",
      "primaryAccount": "true",
      "active": "true",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Financial accounts fetched successfully"
}

Responses

Status	When
`200`	Financial accounts fetched successfully

GET Fetch one record

GET /financial/account/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseSubjectBankAccountResponse

curl -X GET "https://api.bridgemoni.com/financial/account/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",
    "institutionCode": "string",
    "institutionName": {
      "name": "string"
    },
    "institutionCountryCode": "string",
    "accountNumberMasked": "string",
    "accountName": {
      "name": "string"
    },
    "accountType": "main",
    "currencyCode": "string",
    "nameMatchStatus": "EXACT",
    "nameMatchScore": "1",
    "primaryAccount": "true",
    "active": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Financial accounts fetched successfully"
}

Responses

Status	When
`200`	Financial accounts fetched successfully

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