The UBO object

Description

Caution – Legacy endpoints being superseded by the hosted KYC/KYB solution

Mangopay’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.

The UBO object represents one beneficial owner in the legacy API-only KYC/KYB verification flow.

Attributes

Id
string

The unique identifier of the object.

CreationDate
Unix timestamp

The date and time at which the object was created.

LastName
stringRequired

Min. length: 1; max. length: 100

The last name of the individual.

FirstName
stringRequired

Min. length: 1; max. length: 100

The first name of the individual.

Birthday
Unix timestamp

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The date of birth of the individual.

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

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

Required if UserCategory is OWNER. Returned null if UserCategory is PAYER.

The nationality of the individual.

Address
object

The postal address of the user.

AddressLine1
stringRequired

Max. length: 255 characters The first line of the address.

AddressLine2
string

Max. length: 255 characters
The second line of the address.

City
stringRequired

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
stringRequired

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

Country
stringRequired

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

The country of the address.

Birthplace
objectRequired

Information about the beneficial owner’s place of birth.

City
stringRequired

The city in which the beneficial owner was born.

Country
stringRequired

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.