Skip to navigation
User verificationUBO declarations

View a UBO

Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution

Mangopay’s hosted KYC/KYB solution is becoming mandatory for all platforms, and allows Legal Users to declare and verify all beneficial owners in the same IDV Session object.

The criteria defining beneficial owners remain the same.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication 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.
UboIdstringRequired
The unique identifier of the UBO.

Response

Success
IdstringOptional

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

The unique identifier of the object.

CreationDateintegerOptional

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

LastNamestringOptional

Max. length: 100 characters

The last name of the beneficial owner.

FirstNamestringOptional

Max. length: 100 characters

The first name of the beneficial owner.

BirthdayintegerOptional

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.

NationalitystringOptional
The nationality of the beneficial owner.
AddressobjectOptional
The postal address.
BirthplaceobjectOptional
Information about the beneficial owner's place of birth.
IsActivebooleanOptional

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.