Bridge
Contact us
API reference · Identity & onboarding

Beneficiary Owners

POST Add a beneficiary owner to an account holder's business

POST /accountholder/{type}/{value}/beneficiary/owner

Creates a beneficiary owner, cascading creation of any supplied identification documents, sanction screening, and verification.

Headers

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

Path parameters

Name
type
value

Example

Request body: BeneficiaryOwnerRequest · Response: BeneficiaryOwnerResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/beneficiary/owner" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "givenName": "first name",
    "familyName": "last name",
    "fullName": "Ada Obi",
    "nationalityCountryCode": "NG",
    "identifications": [
      {
        "identificationType": "PASSPORT",
        "identificationNumber": "identification number",
        "issuingCountryCode": "NG",
        "issuingAuthority": "Ada Obi",
        "issueDate": "2027-03-14",
        "expiryDate": "2027-03-14",
        "identifier": "identification number",
        "frontImageUrl": "unified resource identifier",
        "backImageUrl": "unified resource identifier"
      }
    ],
    "ownershipPercentage": 1,
    "ownershipControl": "Ada Obi",
    "sanction": {
      "politicallyExposureStatus": true,
      "sanctionMatchStatus": true,
      "sanctionSources": [
        "Ada Obi"
      ],
      "adverseMediaFound": true,
      "lastScreenDateTime": "2027-03-14T14:30:01",
      "nextScreenDateTime": "2027-03-14T14:30:01"
    },
    "verification": {
      "assuranceLevel": 1,
      "verificationDateTime": "2027-03-14T14:30:01"
    }
  }'

Responses

StatusWhen
200Beneficiary owner created successfully

GET Fetch a beneficiary owner by reference

GET /beneficiary/owner/{id}

Headers

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

Path parameters

Name
id

Example

Response: BeneficiaryOwnerResponse

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

Responses

StatusWhen
200Beneficiary owner fetched successfully
404No beneficiary owner exists for the given reference

PUT Update a beneficiary owner

PUT /beneficiary/owner/{id}

Partially updates a beneficiary owner's own scalar fields (name, nationality, ownership percentage/control). 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: UpdateBeneficiaryOwnerRequest · Response: BeneficiaryOwnerResponse

curl -X PUT "https://api.bridgemoni.com/beneficiary/owner/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 '{
    "givenName": "first name",
    "familyName": "last name",
    "fullName": "Ada Obi",
    "nationalityCountryCode": "NG",
    "ownershipPercentage": 1,
    "ownershipControl": "Ada Obi"
  }'

Responses

StatusWhen
200Beneficiary owner updated successfully
404No beneficiary owner exists for the given reference

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