View a UBO Declaration

GET

/v2.01/:ClientId/kyc/ubodeclarations/:UboDeclarationId

GET

/v2.01/:ClientId/kyc/ubodeclarations/:UboDeclarationId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/kyc/ubodeclarations/{UboDeclarationId} \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "Id": "158947737",
3   "UserId": "158947634",
4   "CreationDate": 1672153298,
5   "ProcessedDate": null,
6   "Status": "CREATED",
7   "Reason": null,
8   "Message": null,
9   "Ubos": [
10     {
11       "Id": "158947898",
12       "CreationDate": 1672153693,
13       "LastName": "Wiza",
14       "FirstName": "Jess",
15       "Birthday": 652117514,
16       "Nationality": "FR",
17       "Address": {
18         "AddressLine1": "669 Ratke Forge",
19         "AddressLine2": "Schamberger Walk",
20         "City": "Paris",
21         "Region": "Île-de-France",
22         "PostalCode": "75001",
23         "Country": "FR"
24       },
25       "Birthplace": {
26         "City": "Paris",
27         "Country": "FR"
28       },
29       "IsActive": true
30     }
31   ]
32 }

View a UBO Declaration

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.

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.

UboDeclarationIdstringRequired

The unique identifier of the UBO Declaration.

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.

Uboslist of objects

The list of UBOs attached to the UBO Declaration.