API reference · Identity & onboarding

Company licences

GET/business/licence/{id}Read a company licence
PUT/business/licence/{id}Update a company licence
POST/business/{id}/licenceRecord a regulatory licence for a company
GET/business/{id}/licencesList a company's regulatory licences

GET Read a company licence

GET /business/licence/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseCompanyLicenceResponse

curl -X GET "https://api.bridgemoni.com/business/licence/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",
    "regulatorCode": {
      "name": "string"
    },
    "regulatorName": {
      "name": "string"
    },
    "licenceNumber": "string",
    "licenceCategory": {
      "name": "string"
    },
    "permittedActivities": "string",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "licenceStatus": "ACTIVE",
    "registerUrl": "string",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Company licence retrieved successfully"
}

Responses

Status	When
`200`	Company licence retrieved successfully

PUT Update a company licence

PUT /business/licence/{id}

There is no delete. A licence that was withdrawn is recorded as WITHDRAWN, because a company that once held a licence and no longer does is a different fact from a company that never held one.

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: UpdateCompanyLicenceRequest · Response: GenericResponseCompanyLicenceResponse

curl -X PUT "https://api.bridgemoni.com/business/licence/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 '{
  "regulatorName": {
    "name": "string"
  },
  "licenceNumber": "string",
  "licenceCategory": {
    "name": "string"
  },
  "permittedActivities": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "licenceStatus": "ACTIVE",
  "registerUrl": "string"
}'

{
  "regulatorName": {
    "name": "string"
  },
  "licenceNumber": "string",
  "licenceCategory": {
    "name": "string"
  },
  "permittedActivities": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "licenceStatus": "ACTIVE",
  "registerUrl": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "regulatorCode": {
      "name": "string"
    },
    "regulatorName": {
      "name": "string"
    },
    "licenceNumber": "string",
    "licenceCategory": {
      "name": "string"
    },
    "permittedActivities": "string",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "licenceStatus": "ACTIVE",
    "registerUrl": "string",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Company licence updated successfully"
}

Responses

Status	When
`200`	Company licence updated successfully

POST Record a regulatory licence for a company

POST /business/{id}/licence

The regulator, the licence number, what it permits and when it lapses. The expiry date is load-bearing rather than informational: a licence that expires withdraws the regulated resources it was granting, without anybody acting.

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: CompanyLicenceRequest · Response: GenericResponseCompanyLicenceResponse

curl -X POST "https://api.bridgemoni.com/business/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/licence" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "regulatorCode": {
    "name": "string"
  },
  "regulatorName": {
    "name": "string"
  },
  "licenceNumber": "string",
  "licenceCategory": {
    "name": "string"
  },
  "permittedActivities": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "licenceStatus": "ACTIVE",
  "registerUrl": "string"
}'

{
  "regulatorCode": {
    "name": "string"
  },
  "regulatorName": {
    "name": "string"
  },
  "licenceNumber": "string",
  "licenceCategory": {
    "name": "string"
  },
  "permittedActivities": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "licenceStatus": "ACTIVE",
  "registerUrl": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "regulatorCode": {
      "name": "string"
    },
    "regulatorName": {
      "name": "string"
    },
    "licenceNumber": "string",
    "licenceCategory": {
      "name": "string"
    },
    "permittedActivities": "string",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "licenceStatus": "ACTIVE",
    "registerUrl": "string",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Company licence created successfully"
}

Responses

Status	When
`200`	Company licence created successfully

GET List a company's regulatory licences

GET /business/{id}/licences

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseListCompanyLicenceResponse

curl -X GET "https://api.bridgemoni.com/business/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/licences" \
  -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",
      "regulatorCode": {
        "name": "string"
      },
      "regulatorName": {
        "name": "string"
      },
      "licenceNumber": "string",
      "licenceCategory": {
        "name": "string"
      },
      "permittedActivities": "string",
      "issueDate": "2026-09-25",
      "expiryDate": "2026-09-25",
      "licenceStatus": "ACTIVE",
      "registerUrl": "string",
      "lastCheckedDateTime": "2026-09-25T10:00:00Z",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "Company licences retrieved successfully"
}

Responses

Status	When
`200`	Company licences retrieved successfully

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