Bridge
Contact us
API reference · Identity & onboarding

Businesses

KYB for the businesses your customers run. About business verification Live

GET List businesses for an account holder

GET /accountholder/{type}/{value}/business

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
type
value

Example

Response: List<BusinessResponse>

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

Responses

StatusWhen
200Businesses fetched successfully

POST Add a business to an account holder

POST /accountholder/{type}/{value}/business

Creates a business profile, cascading creation of any supplied tax residences, addresses, contacts, beneficiary owners, expected activity, sanction, risk, and verification.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
type
value

Example

Request body: BusinessRequest · Response: BusinessResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/business" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "legalName": "Ada Obi",
    "tradingName": "Ada Obi",
    "registrationNumber": "identification number",
    "registrationCountryCode": "NG",
    "registrationAuthority": "Ada Obi",
    "businessType": "category",
    "registrationType": "category",
    "industry": "category",
    "registrationDate": "2027-03-14",
    "website": "unified resource identifier",
    "taxResidences": [
      {
        "taxIdentificationNumber": "identification number",
        "countryCode": "NG",
        "taxIdentificationType": "TIN"
      }
    ],
    "addresses": [
      {
        "addressType": "POSTAL",
        "streetName": "street name",
        "buildingNumber": "house number",
        "postCode": "101241",
        "town": "Lagos",
        "district": "district code",
        "province": "province",
        "countryCode": "NG",
        "landmark": "landmark"
      }
    ],
    "contacts": [
      {
        "emailAddress": "ada@example.com",
        "msisdn": "+2348012345678",
        "preferredChannel": "SMS",
        "preferredLanguageCode": "language code"
      }
    ],
    "beneficiaryOwners": [
      {
        "givenName": "first name",
        "familyName": "last name",
        "fullName": "Ada Obi",
        "nationalityCountryCode": "NG",
        "identifications": [
          {
            "...": "nested"
          }
        ],
        "ownershipPercentage": 1,
        "ownershipControl": "Ada Obi",
        "sanction": {
          "...": "nested"
        },
        "verification": {
          "...": "nested"
        }
      }
    ],
    "expectedActivity": {
      "monthlyVolume": 250000.0,
      "currencyCode": "NGN",
      "purpose": "March payroll"
    },
    "sanction": {
      "politicallyExposureStatus": true,
      "sanctionMatchStatus": true,
      "sanctionSources": [
        "Ada Obi"
      ],
      "adverseMediaFound": true,
      "lastScreenDateTime": "2027-03-14T14:30:01",
      "nextScreenDateTime": "2027-03-14T14:30:01"
    },
    "risk": {
      "level": "category",
      "score": 1,
      "cddLevel": "category",
      "riskFactors": [
        {
          "...": "nested"
        }
      ],
      "accessedDateTime": "2027-03-14T14:30:01",
      "reviewDate": "2027-03-14"
    },
    "verification": {
      "assuranceLevel": 1,
      "verificationDateTime": "2027-03-14T14:30:01"
    }
  }'

Responses

StatusWhen
200Business created successfully

GET Fetch a business by reference

GET /business/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
id

Example

Response: BusinessResponse

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

Responses

StatusWhen
200Business fetched successfully
404No business exists for the given reference

PUT Update a business

PUT /business/{id}

Partially updates a business's own scalar fields (legal/trading name, registration details, business type, industry, website). Only non-null fields in the request body are applied.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
id

Example

Request body: UpdateBusinessRequest · Response: BusinessResponse

curl -X PUT "https://api.bridgemoni.com/business/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 '{
    "legalName": "Ada Obi",
    "tradingName": "Ada Obi",
    "registrationNumber": "identification number",
    "registrationCountryCode": "NG",
    "registrationAuthority": "Ada Obi",
    "businessType": "category",
    "registrationType": "category",
    "industry": "category",
    "registrationDate": "2027-03-14",
    "website": "unified resource identifier"
  }'

Responses

StatusWhen
200Business updated successfully
404No business exists for the given reference

POST Upload a business's registration document

POST /business/{id}/document

Stores the uploaded file via the document module and attaches its reference as the business's registration certificate/incorporation document. A single document - unlike identification/address, there is no front/back side.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-TypeMULTIPART

Path parameters

Name
id

Query parameters

NameDefault
fileOptional

Example

Response: BusinessResponse

curl -X POST "https://api.bridgemoni.com/business/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/document?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"

Responses

StatusWhen
200Document uploaded successfully
404No business exists for the given reference

GET Fetch a short-lived download URL for a business's registration document

GET /business/{id}/document/url

Returns a presigned URL (valid for a limited time).

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
id

Example

Response: String

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

Responses

StatusWhen
200Document URL fetched successfully
404No registration document has been uploaded yet

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