View a UBO Declaration

Read more about the UBO Declaration object →

Path parameters

UboDeclarationId · string · required

The unique identifier of the UBO Declaration.

Responses

200

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

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.

Hide properties

Object (UBO) · object

The UBO object created by the platform.

Hide properties

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.

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

<?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';

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

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