View a UBO

Read more about the UBO object →

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

200

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 characters

The last name of the beneficial owner.

FirstName · string

Max. length: 100 characters

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

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

Birthplace · object

Information about the beneficial owner’s place of birth.

Show properties

City · string

The city in which the beneficial owner was born.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country in which the beneficial owner was born.

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.

200

{
    "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

<?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);
}