Overview
User management
- Users
- User regulatory status
- User e-money
User verification
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a UBO Declaration
<?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 = '199463368';
$response = $api->UboDeclarations->Create($userId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
{
"Id": "ubo_m_01JH7TS09VMCDVV7B39F4A2JAF",
"UserId": "user_m_01JH2Z508798F23M9FB9T9Z2Y7",
"CreationDate": 1736503492,
"ProcessedDate": null,
"Status": "CREATED",
"Reason": null,
"Message": null,
"Ubos": []
}
Read more about the UBO Declaration object →
Path parameters
The unique identifier of the user.
Responses
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, 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 theReasonandMessagefields.
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.
The unique identifier of the object.
The date and time at which the object was created.
Max. length: 100 characters
The last name of the beneficial owner.
The nationality of the beneficial owner.
The postal address of the beneficial owner.
Max. length: 255 characters
The first line of the address.
Max. length: 255 characters
The second line of the address.
Max. length: 255 characters
The city of the address.
Max. length: 255 characters
The region of the address. This field is optional except if the Country is US, CA, or MX.
Max. length: 255 characters
The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
Information about the beneficial owner’s place of birth.
The city in which the beneficial owner was born.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country 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.
{
"Message": "You can not request validation for a declaration which has no ubo",
"Type": "invalid_action",
"Id": "96ee403c-1a23-46c9-8b2e-1e56c7e80325#1672326575",
"Date": 1672326576.0,
"errors": null
}
{
"Message": "You can not create a declaration because you already have a declaration in progress",
"Type": "invalid_action",
"Id": "5b9c158f-2a55-44c0-b14b-e3cf62a5f2c4#1672326207",
"Date": 1672326208.0,
"errors": null
}
{
"Message": "Cannot create an UBO for a LegalUser of type SOLETRADER",
"Type": "invalid_action",
"Id": "f2da32db-43cd-405b-b7c2-d50ab14f41d8#1672326440",
"Date": 1672326441.0,
"errors": null
}
{
"Message": "User belonging to category PAYER can't create UBO declarations",
"Type": "invalid_action",
"Id": "96ee403c-1a23-46c9-8b2e-1e56c7e80325#1672326575",
"Date": 1672326576.0,
"errors": null
}
{
"Id": "ubo_m_01JH7TS09VMCDVV7B39F4A2JAF",
"UserId": "user_m_01JH2Z508798F23M9FB9T9Z2Y7",
"CreationDate": 1736503492,
"ProcessedDate": null,
"Status": "CREATED",
"Reason": null,
"Message": null,
"Ubos": []
}
<?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 = '199463368';
$response = $api->UboDeclarations->Create($userId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
Was this page helpful?
<?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 = '199463368';
$response = $api->UboDeclarations->Create($userId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}
{
"Id": "ubo_m_01JH7TS09VMCDVV7B39F4A2JAF",
"UserId": "user_m_01JH2Z508798F23M9FB9T9Z2Y7",
"CreationDate": 1736503492,
"ProcessedDate": null,
"Status": "CREATED",
"Reason": null,
"Message": null,
"Ubos": []
}