The UBO Declaration object

Description

The UBO Declaration object is a container to provide information regarding the ultimate of a legal entity. It is mandatory for legal users with LegalPersonType of BUSINESS or PARTNERSHIP.

See the glossary for details on the criteria defining beneficial owners.

Attributes

string

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.

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.

Array (UBOs)

array

The list of UBOs attached to the UBO Declaration.

Show properties

Object (UBO)

object

The UBO object created by the platform.

Show properties

string

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 Dashboard user.

Birthday

Unix timestamp

The date of birth of the user.

Returned null if UserCategory is PAYER.

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

Returned null if UserCategory is PAYER.

Address

object

The postal address of the user.

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

Required if Country is US, CA, or MX.

The region of the address.

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, set this parameter to false. This action is irreversible.

How to

How to submit a UBO Declaration

Guide

Learn more about beneficial owners

On this page

Description
Attributes
Related resources

Description

The UBO Declaration object is a container to provide information regarding the ultimate of a legal entity. It is mandatory for legal users with LegalPersonType of BUSINESS or PARTNERSHIP.

See the glossary for details on the criteria defining beneficial owners.

Attributes

string

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.

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.

Array (UBOs)

array

The list of UBOs attached to the UBO Declaration.

Show properties

Object (UBO)

object

The UBO object created by the platform.

Show properties

string

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 Dashboard user.

Birthday

Unix timestamp

The date of birth of the user.

Returned null if UserCategory is PAYER.

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

Returned null if UserCategory is PAYER.

Address

object

The postal address of the user.

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

Required if Country is US, CA, or MX.

The region of the address.

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, set this parameter to false. This action is irreversible.

How to

How to submit a UBO Declaration

Guide

Learn more about beneficial owners

On this page

Description
Attributes
Related resources

The UBO Declaration object

Description

Attributes

How to

Guide

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

The UBO Declaration object

Description

Attributes

How to

Guide

​Description

​Attributes

​Related resources

How to

Guide

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Description

​Attributes

​Related resources

How to

Guide

Description

Attributes

Related resources

Description

Attributes

Related resources