Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
uboDeclarations

List UBO Declarations for a User

<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>

get/v2.01/{ClientId}/users/{UserId}/kyc/ubodeclarations

Path parameters

ClientIdstring required

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

UserIdstring required

The unique identifier of the user.

Query parameters

pageinteger

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageinteger

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

Sortstring

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

Indicates the direction in which to sort the list.

Headers

Authorizationstring required

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.

Response

Success

Idstring

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

The unique identifier of the object.

UserIdstring

The unique identifier of the user.

CreationDateinteger

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

ProcessedDateinteger

Unix timestamp (UTC) of the date and time the UBO Declaration was processed by Mangopay’s team.

Statusstring

Returned values: CREATED, VALIDATION_ASKED, INCOMPLETE, VALIDATED, REFUSED

The status of the declaration:

  • CREATED – The UBO Declaration is created, but not submitted yet.
  • VALIDATION_ASKED – The UBO Declaration is submitted for validation.
  • INCOMPLETE – The UBO Declaration is deemed incomplete by Mangopay teams.
  • VALIDATED – The UBO Declaration is validated by Mangopay’s team.
  • REFUSED – The UBO Declaration is rejected by Mangopay’s team. You can learn more about the reasons for refusal in the Reason and  Message fields.
Reasonstring

The reason for which the UBO Declaration was REFUSED or considered as INCOMPLETE.

Messagestring

Additional information about why the UBO Declaration was refused or marked as incomplete, provided by Mangopay’s team.