Skip to main content
POST
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
kyc
/
ubodeclarations
/
{UboDeclarationId}
/
ubos
{
    "FirstName": "AcceptUBO",
    "LastName": "Effertz",
    "Birthday": 652117514,
    "Nationality": "FR",
    "Address": {
        "AddressLine1": "804 Hane Mountains",
        "AddressLine2": "Adriel Overpass",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75001",
        "Country": "FR"
    },
    "Birthplace": {
        "City": "Paris",
        "Country": "FR"
    }
}  

{
    "Id": "ubo_m_01JH7TS5ZHW3R501ACJEKD5G39",
    "CreationDate": 1736503498,
    "LastName": "Effertz",
    "FirstName": "Michaela",
    "Birthday": 652117514,
    "Nationality": "FR",
    "Address": {
        "AddressLine1": "804 Hane Mountains",
        "AddressLine2": "Adriel Overpass",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75001",
        "Country": "FR"
    },
    "Birthplace": {
        "City": "Paris",
        "Country": "FR"
    },
    "IsActive": true
}
Note – Use test data to simulate outcomeIn Sandbox, you can set the FirstName of the first UBO to simulate the outcome (Status) of the declaration after submission:
  • AcceptUBO for VALIDATED
  • RefusedUBO for REFUSED
  • IncompleteUBO for INCOMPLETE
See the guide for more details →

​
Path parameters

​
UserId
string
required
The unique identifier of the user.
​
UboDeclarationId
string
required
The unique identifier of the UBO Declaration.

​
Body parameters

​
LastName
string
required
Max. length: 100 charactersThe last name of the beneficial owner.
​
FirstName
string
required
Max. length: 100 charactersThe first name of the beneficial owner.
​
Birthday
Unix timestamp
required
The date of birth of the beneficial owner.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
required
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The nationality of the beneficial owner.
​
Address
object
required
The postal address of the beneficial owner.
​
Birthplace
object
required
Information about the beneficial owner’s place of birth.

​
Responses

​
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 charactersThe last name of the beneficial owner.
​
FirstName
string
Max. length: 100 charactersThe first name of the beneficial owner.
​
Birthday
Unix timestamp
The date of birth of the beneficial owner.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 beneficial owner.
​
Address
object
The postal address of the beneficial owner.
​
Birthplace
object
Information about the beneficial owner’s place of birth.
​
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.
{
    "Message": "You can not create more than 15 UBO for a declaration",
    "Type": "invalid_action",
    "Id": "f5c1f9c7-bafa-4fe9-b5b1-2b005d0e6f8a",
    "Date": 1698759679.0,
    "errors": null
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "2951739b-416e-43a4-a40b-8e8d6ba52719",
    "Date": 1717664987.0,
    "errors": {
        "Region": "The Region is a required field for this Country"
    }
}

{
    "Id": "ubo_m_01JH7TS5ZHW3R501ACJEKD5G39",
    "CreationDate": 1736503498,
    "LastName": "Effertz",
    "FirstName": "Michaela",
    "Birthday": 652117514,
    "Nationality": "FR",
    "Address": {
        "AddressLine1": "804 Hane Mountains",
        "AddressLine2": "Adriel Overpass",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75001",
        "Country": "FR"
    },
    "Birthplace": {
        "City": "Paris",
        "Country": "FR"
    },
    "IsActive": true
}

{
    "FirstName": "AcceptUBO",
    "LastName": "Effertz",
    "Birthday": 652117514,
    "Nationality": "FR",
    "Address": {
        "AddressLine1": "804 Hane Mountains",
        "AddressLine2": "Adriel Overpass",
        "City": "Paris",
        "Region": "Île-de-France",
        "PostalCode": "75001",
        "Country": "FR"
    },
    "Birthplace": {
        "City": "Paris",
        "Country": "FR"
    }
}
⌘I