uboDeclarations

Create a UBO

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **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. </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 →

post/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations/{UboDeclarationId}/ubos
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

UserIdstring required

The unique identifier of the user.

UboDeclarationIdstring required

The unique identifier of the UBO Declaration.

Request body

LastNamestring required

Max. length: 100 characters

The last name of the beneficial owner.

FirstNamestring required

Max. length: 100 characters

The first name of the beneficial owner.

Birthdayinteger required

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 required

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

The nationality of the beneficial owner.

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.

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.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_ubo removed and replaced with uboDeclarations_create_ubo