User verificationUBO declarations

Create a UBO

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution** Mangopay's [hosted KYC/KYB solution](/guides/users/verification/hosted) is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same [IDV Session](/api-reference/idv-sessions/idv-session-object) object. The [criteria defining beneficial owners](/guides/glossary#beneficial-owner-ubo) remain the same. </Warning> In Sandbox, you can set the `FirstName` of the first UBO to simulate the outcome (`Status`) of the declaration after submission: - `AcceptUBO` for `VALIDATED` - `RefusedUBO` for `REFUSED` - `IncompleteUBO` for `INCOMPLETE` [See the guide for more details](/guides/users/verification/beneficial-owners/how-to) **&rarr;**

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
UserIdstringRequired
The unique identifier of the user.
UboDeclarationIdstringRequired
The unique identifier of the UBO Declaration.

Request

This endpoint expects an object.
LastNamestringRequired

Max. length: 100 characters

The last name of the beneficial owner.

FirstNamestringRequired

Max. length: 100 characters

The first name of the beneficial owner.

BirthdayintegerRequired

The date of birth of the beneficial owner.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.

NationalitystringRequired

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The nationality of the beneficial owner.

AddressobjectRequired
The postal address.
BirthplaceobjectRequired
Information about the beneficial owner's place of birth.

Response

Success
Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

LastNamestring

Max. length: 100 characters

The last name of the beneficial owner.

FirstNamestring

Max. length: 100 characters

The first name of the beneficial owner.

Birthdayinteger

The date of birth of the beneficial owner.

Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.

Nationalitystring
The nationality of the beneficial owner.
Addressobject
The postal address.
Birthplaceobject
Information about the beneficial owner's place of birth.
IsActiveboolean

Whether or not the UBO is considered in the declaration. To disregard a UBO, this parameter must be set to false. This action is irreversible.

Errors

400
Bad Request Error