Skip to navigation
User verificationUBO declarations

List UBO Declarations for a User

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.

Query parameters

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageintegerOptional

Min. value: 1; max. value: 100

Default value: 10

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

SortstringOptional

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

Indicates the direction in which to sort the list.

Response

Success
IdstringOptional

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

The unique identifier of the object.

UserIdstringOptional
The unique identifier of the user.
CreationDateintegerOptional

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

ProcessedDateintegerOptional

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

StatusstringOptional

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

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

MessagestringOptional
Additional information about why the UBO Declaration was refused or marked as incomplete, provided by Mangopay's team.
Uboslist of objectsOptional
The list of UBOs attached to the UBO Declaration.