The UBO Declaration object

An UBO Declaration is an electronic version of the previous KYC document "Shareholder Declaration", in order to declare all the Ultimate Beneficial Owners of a BUSINESS-typed legal User (ie the shareholders with >25% ownership).

  1. Create each Ultimate Beneficial Owner as a Natural User, who must have a "DECLARATIVE" Capacity.
  2. Create a new UBO Declaration for your legal user, and link every Ultimate Beneficial Owners created previously thanks to DeclaredUBOs. This list can be empty if your legal user has no Ultimate Beneficial Owner, or no eligible one (ie. no Ultimate Beneficial Owner that owns more than 25% of this company).
  3. Edit the UBODeclaration object and set the Status field to "VALIDATION_ASKED" (instead of "CREATED")
  4. The demand is received by our team and once processed, it will either get a "VALIDATED" status, or "REFUSED" with more information provided in the RefusedReasonTypes parameter

Note that UBO declarations are not yet a requirement for your user to be KYC verified and are optional at this stage

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

UserId
string

string:

Maximum length is 255 characters

The object owner's UserId

Status
UBODeclarationStatus

UBODeclarationStatus

Status of a UBO Declaration

RefusedReasonTypes
list

list:

List of Refused Reason Type

Reason types for a UBO Declaration

RefusedReasonMessage
string

string:

Maximum length is 255 characters

Refused Reason Message for a UBO Declaration

DeclaredUBOs
list

list

An array of UserIDs declared as Ultimate Beneficial Owners of a BUSINESS Legal User.

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"UserId": "8494514",
"Status": "CREATED",
"RefusedReasonTypes": [ "INVALID_UBO_DETAILS" ],
"RefusedReasonMessage": "blabla",
"DeclaredUBOs": [ "8494514" ]
}

Create an UBO Declaration

POST .../v2.01/ClientId

The ID of your client account

/users/UserId

A Mangopay user's ID

/ubodeclarations/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

DeclaredUBOs
list

list

optional

An array of UserIDs declared as Ultimate Beneficial Owners of a BUSINESS Legal User.

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../users/:UserId/ubodeclarations/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"DeclaredUBOs": [ "8494514" ]
}
POST .../users//ubodeclarations/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"DeclaredUBOs": [ "" ]
}

Update an UBO declaration

PUT .../v2.01/ClientId

The ID of your client account

/ubodeclarations/UBODeclarationId

ID of a UBO Declaration

/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

Status
UBODeclarationStatus

UBODeclarationStatus

optional

Status of a UBO Declaration

DeclaredUBOs
list

list

optional

An array of UserIDs declared as Ultimate Beneficial Owners of a BUSINESS Legal User.

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
PUT .../ubodeclarations/:UBODeclarationId/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"Status": "CREATED",
"DeclaredUBOs": [ "8494514" ]
}
PUT .../ubodeclarations// HTTP/1.1
Body Parameters :
{
"Tag": "",
"Status": "",
"DeclaredUBOs": [ "" ]
}

View an UBO Declaration

GET .../v2.01/ClientId

The ID of your client account

/ubodeclarations/UBODeclarationId

ID of a UBO Declaration

/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../ubodeclarations/:UBODeclarationId/ HTTP/1.1
GET .../ubodeclarations// HTTP/1.1