API reference · Identity & onboarding

Company bank accounts

GET/business/bank/account/{id}Read a company bank account
PUT/business/bank/account/{id}Update a company bank account
POST/business/{id}/bank/accountRecord a company bank account
GET/business/{id}/bank/accountsList a company's bank accounts

GET Read a company bank account

GET /business/bank/account/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseCompanyBankAccountResponse

curl -X GET "https://api.bridgemoni.com/business/bank/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",
    "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "institutionCode": "string",
    "institutionName": {
      "name": "string"
    },
    "accountNumberMasked": "string",
    "accountName": {
      "name": "string"
    },
    "currencyCode": "string",
    "nameMatchStatus": "EXACT",
    "settlementAccount": "true",
    "active": "true",
    "verifiedDateTime": "2026-09-25T10:00:00Z",
    "verificationProvider": {
      "name": "string"
    }
  },
  "description": "Company bank account retrieved successfully"
}

Responses

Status	When
`200`	Company bank account retrieved successfully

PUT Update a company bank account

PUT /business/bank/account/{id}

There is no delete. Set active false to retire an account: one that was once settled to must remain answerable for the payments that went to it.

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: UpdateCompanyBankAccountRequest · Response: GenericResponseCompanyBankAccountResponse

curl -X PUT "https://api.bridgemoni.com/business/bank/account/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 '{
  "institutionName": {
    "name": "string"
  },
  "accountName": {
    "name": "string"
  },
  "currencyCode": "string",
  "settlementAccount": "true",
  "active": "true"
}'

{
  "institutionName": {
    "name": "string"
  },
  "accountName": {
    "name": "string"
  },
  "currencyCode": "string",
  "settlementAccount": "true",
  "active": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "institutionCode": "string",
    "institutionName": {
      "name": "string"
    },
    "accountNumberMasked": "string",
    "accountName": {
      "name": "string"
    },
    "currencyCode": "string",
    "nameMatchStatus": "EXACT",
    "settlementAccount": "true",
    "active": "true",
    "verifiedDateTime": "2026-09-25T10:00:00Z",
    "verificationProvider": {
      "name": "string"
    }
  },
  "description": "Company bank account updated successfully"
}

Responses

Status	When
`200`	Company bank account updated successfully

POST Record a company bank account

POST /business/{id}/bank/account

Which account a company settles to. The number is held masked: this record exists to say where money goes, not to be a payment instrument. Unlike every other fact in this module it carries no assurance grade - its evidence is the name match, and there is no weaker or stronger way to hold that.

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: CompanyBankAccountRequest · Response: GenericResponseCompanyBankAccountResponse

curl -X POST "https://api.bridgemoni.com/business/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/bank/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"
  },
  "accountNumberMasked": "string",
  "accountName": {
    "name": "string"
  },
  "currencyCode": "string",
  "settlementAccount": "true"
}'

{
  "institutionCode": "string",
  "institutionName": {
    "name": "string"
  },
  "accountNumberMasked": "string",
  "accountName": {
    "name": "string"
  },
  "currencyCode": "string",
  "settlementAccount": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "institutionCode": "string",
    "institutionName": {
      "name": "string"
    },
    "accountNumberMasked": "string",
    "accountName": {
      "name": "string"
    },
    "currencyCode": "string",
    "nameMatchStatus": "EXACT",
    "settlementAccount": "true",
    "active": "true",
    "verifiedDateTime": "2026-09-25T10:00:00Z",
    "verificationProvider": {
      "name": "string"
    }
  },
  "description": "Company bank account created successfully"
}

Responses

Status	When
`200`	Company bank account created successfully

GET List a company's bank accounts

GET /business/{id}/bank/accounts

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseListCompanyBankAccountResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "institutionCode": "string",
      "institutionName": {
        "name": "string"
      },
      "accountNumberMasked": "string",
      "accountName": {
        "name": "string"
      },
      "currencyCode": "string",
      "nameMatchStatus": "EXACT",
      "settlementAccount": "true",
      "active": "true",
      "verifiedDateTime": "2026-09-25T10:00:00Z",
      "verificationProvider": {
        "name": "string"
      }
    }
  ],
  "description": "Company bank accounts retrieved successfully"
}

Responses

Status	When
`200`	Company bank accounts retrieved successfully

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