Link a UBO

post

https://api.stage.localpayment.com/api/entity/v1/entities/{companyId}/ubos

Links an INDIVIDUAL entity as ultimate beneficial owner (UBO) of a COMPANY entity, with the ownership percentage and control role.

Path Params

companyId

uuid

required

internalId of the COMPANY.

Body Params

personId

uuid

required

internalId of the INDIVIDUAL.

ownershipPercentage

number | null

required

0 to 100, up to two decimals. Send null when the percentage is unknown, and 0 for a legal representative who doesn't own shares.

controlRole

string

enum

Role of the person, one of the 24 codes. Case-sensitive: director returns 422 INVALID_CONTROL_ROLE. Use LEGAL_REPRESENTATIVE for the legal representative and AUTHORIZED_SIGNATORY for a person who signs under a power of attorney.

validFrom

date

YYYY-MM-DD. Default: today.

validTo

date

YYYY-MM-DD, on or after validFrom. Omit for an open-ended link.

Headers

X-Correlation-ID

string

Trace identifier (UUID). Echoed in the response; generated by Localpayment if absent.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Created.

400Bad Request. VALIDATION_ERROR: A field, header, path or query parameter is missing, unknown or invalid. details[] lists field and issue.

401Unauthorized. UNAUTHORIZED: Missing or invalid access token.

404Not Found. ENTITY_NOT_FOUND: The entity does not exist or belongs to another merchant.

409Conflict. ENTITY_IN_REVIEW: The entity is IN_REVIEW: its data, documents, files and UBO links are frozen until Localpayment Compliance resolves it. UBO_ALREADY_LINKED: The person already has an active UBO link with this company. UBO_LIMIT_EXCEEDED: The company already has 50 active UBO links.