Skip to main content
GET
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
kyc
/
ubodeclarations
<?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);
}  

[
    {
        "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
            }
        ]
    }
]
Read more about the UBO Declaration object →

​
Query parameters

​
page
integer
Start value: 1Default value: 1Indicates the index of the page for the pagination.
​
per_page
integer
Min. value: 1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.
​
Sort
string
Allowed values: CreationDate:ASC, CreationDate:DESCIndicates the direction in which to sort the list.

​
Path parameters

​
UserId
string
required
The unique identifier of the user.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
UserId
string
The unique identifier of the user.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
ProcessedDate
Unix timestamp
The date and time at which the UBO Declaration was processed by Mangopay’s team.
​
Status
string
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.
​
Reason
string
The reason for which the UBO Declaration was REFUSED or considered as INCOMPLETE.
​
Message
string
Additional information about why the UBO Declaration was refused or marked as incomplete, provided by Mangopay’s team.
​
Ubos
array
The list of UBOs attached to the UBO Declaration.
[
    {
        "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);
}