API reference · Identity & onboarding

Business roles

POST/accountholder/{type}/{value}/business/roleRecord a person's role in a company
GET/accountholder/{type}/{value}/business/rolesList an account holder's records
GET/business/role/{id}Fetch one record

POST Record a person's role in a company

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

Directorships, shareholdings and ultimate control. Whether someone is a director or a UBO is computed from these rows rather than stored as a flag.

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: BusinessRoleRequest · Response: GenericResponseBusinessRoleResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/business/role" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "companyRegistrationNumber": "string",
  "companyName": {
    "name": "string"
  },
  "companyCountryCode": "string",
  "role": "DIRECTOR",
  "shareholdingPercentage": {
    "rate": 0
  },
  "controlBasis": "SHARES",
  "appointedDate": "2026-09-25",
  "resignedDate": "2026-09-25",
  "sourceRegister": {
    "name": "string"
  }
}'

{
  "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "companyRegistrationNumber": "string",
  "companyName": {
    "name": "string"
  },
  "companyCountryCode": "string",
  "role": "DIRECTOR",
  "shareholdingPercentage": {
    "rate": 0
  },
  "controlBasis": "SHARES",
  "appointedDate": "2026-09-25",
  "resignedDate": "2026-09-25",
  "sourceRegister": {
    "name": "string"
  }
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "businessReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "companyRegistrationNumber": "string",
    "companyName": {
      "name": "string"
    },
    "companyCountryCode": "string",
    "role": "DIRECTOR",
    "shareholdingPercentage": {
      "rate": 0
    },
    "controlBasis": "SHARES",
    "appointedDate": "2026-09-25",
    "resignedDate": "2026-09-25",
    "sourceRegister": {
      "name": "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": "Business roles created successfully"
}

Responses

Status	When
`200`	Business roles created successfully

GET List an account holder's records

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

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListBusinessRoleResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/business/roles" \
  -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",
      "companyRegistrationNumber": "string",
      "companyName": {
        "name": "string"
      },
      "companyCountryCode": "string",
      "role": "DIRECTOR",
      "shareholdingPercentage": {
        "rate": 0
      },
      "controlBasis": "SHARES",
      "appointedDate": "2026-09-25",
      "resignedDate": "2026-09-25",
      "sourceRegister": {
        "name": "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": "Business roles fetched successfully"
}

Responses

Status	When
`200`	Business roles fetched successfully

GET Fetch one record

GET /business/role/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseBusinessRoleResponse

curl -X GET "https://api.bridgemoni.com/business/role/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",
    "companyRegistrationNumber": "string",
    "companyName": {
      "name": "string"
    },
    "companyCountryCode": "string",
    "role": "DIRECTOR",
    "shareholdingPercentage": {
      "rate": 0
    },
    "controlBasis": "SHARES",
    "appointedDate": "2026-09-25",
    "resignedDate": "2026-09-25",
    "sourceRegister": {
      "name": "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": "Business roles fetched successfully"
}

Responses

Status	When
`200`	Business roles fetched successfully

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