Read more about the UBO Declaration object →
Query parameters
Start value: 1Default value: 1Indicates the index of the page for the pagination.
Min. value: 1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.
Allowed values: CreationDate:ASC, CreationDate:DESCIndicates the direction in which to sort the list.
Path parameters
The unique identifier of the user.
Responses
Max length: 128 characters (see data formats for details)The unique identifier of the object. The unique identifier of the user.
The date and time at which the object was created.
The date and time at which the UBO Declaration was processed by Mangopay’s team.
Returned values: CREATED, VALIDATION_ASKED, INCOMPLETE, VALIDATED, REFUSEDThe 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.
The reason for which the UBO Declaration was REFUSED or considered as INCOMPLETE.
Additional information about why the UBO Declaration was refused or marked as incomplete, provided by Mangopay’s team.
The list of UBOs attached to the UBO Declaration.
The UBO object created by the platform.
Max length: 128 characters (see data formats for details)The unique identifier of the object. The date and time at which the object was created.
Max. length: 100 charactersThe last name of the beneficial owner.
The nationality of the beneficial owner.
The postal address of the beneficial owner.
Max. length: 255 charactersThe first line of the address.
Max. length: 255 charactersThe second line of the address.
Max. length: 255 charactersThe city of the address.
Max. length: 255 charactersThe region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Information about the beneficial owner’s place of birth.
The city in which the beneficial owner was born.
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.
[
{
"Id": "158947737",
"UserId": "158947634",
"CreationDate": 1672153298,
"ProcessedDate": null,
"Status": "CREATED",
"Reason": null,
"Message": null,
"Ubos": [
{
"Id": "158947898",
"CreationDate": 1672153693,
"LastName": "Wiza",
"FirstName": "Jess",
"Birthday": 652117514,
"Nationality": "FR",
"Address": {
"AddressLine1": "669 Ratke Forge",
"AddressLine2": "Schamberger Walk",
"City": "Paris",
"Region": "Île-de-France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthplace": {
"City": "Paris",
"Country": "FR"
},
"IsActive": true
}
]
}
]
<?php
require_once 'vendor/autoload.php';
use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;
$api = new MangoPayApi();
$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';
try {
$userId = '170853400';
$response = $api->UboDeclarations->GetAll($userId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
