Skip to main content
GET
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
kyc
/
ubodeclarations
/
{UboDeclarationId}
/
ubos
/
{UboId}
<?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 = '198557165';
    $uboDeclarationId = '198692872';
    $uboId = '198693429';

    $response = $api->UboDeclarations->GetUbo($userId, $uboDeclarationId, $uboId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}  

{
    "Id": "ubo_m_01JH7TS5ZHW3R501ACJEKD5G39",
    "CreationDate": 1736503498,
    "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt

Use this file to discover all available pages before exploring further.

Caution – Legacy endpoints being superseded by the hosted KYC/KYB solutionMangopay’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.

​
Path parameters

​
UserId
string
required
The unique identifier of the user.
​
UboDeclarationId
string
required
The unique identifier of the UBO Declaration.
​
UboId
string
required
The unique identifier of the UBO.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
LastName
string
Max. length: 100 charactersThe last name of the beneficial owner.
​
FirstName
string
Max. length: 100 charactersThe first name of the beneficial owner.
​
Birthday
Unix timestamp
The date of birth of the beneficial owner.Note: This is a Unix timestamp in UTC. Ensure you convert your timezone to UTC to avoid midnight being interpreted as the day before.
​
Nationality
string
The nationality of the beneficial owner.
​
Address
object
The postal address of the beneficial owner.
​
Birthplace
object
Information about the beneficial owner’s place of birth.
​
IsActive
boolean
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": "ubo_m_01JH7TS5ZHW3R501ACJEKD5G39",
    "CreationDate": 1736503498,
    "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 = '198557165';
    $uboDeclarationId = '198692872';
    $uboId = '198693429';

    $response = $api->UboDeclarations->GetUbo($userId, $uboDeclarationId, $uboId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}