Natural Persons
Create new natural person
Gender
All first names of the person according to the identification document
^\S+( \S+)*$Natural person last name
Country code in ISO 3166-1 alpha-2 standard
Language code in ISO 639-1 two-letter codes (EU only)
FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.).
Annual income net
Available assets
External Id in partner's system. This value has to be unique
OK
Bad Request
Conflict
Get natural persons
String value used for pagination
Maximum number of items to return
20Natural person status Filter
Natural person role
OK
Bad Request
Get natural person
Natural Person ID.
OK
Bad Request
Not Found
Update natural person
Natural Person ID.
Document ID in UUID format for those params where a document upload is required (title, lastName, deathDay)
OK
No content
Bad Request
No content
Create new natural person identification
The legal name of the vendor/company performing the identification for this natural person
Method used to identify the customer
Date on which the identification was carried out. The date must be within the last 24 months.
Type of the identification document which has been used for identification of the natural person.
Document number of the identification document.
Issuing country of the identification document.
Issuing authority of the identification document
Issue date of the identification document
Expiry date of the identification document. If the identification document is a birth certificate, the date on which the person comes of age must be entered as the expiry date.
Full name of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE
Residence city of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE
Full name of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE
Residence city of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE
Accepted
Bad Request
No content
Create Identification Verification
After successful request link to a video call should be retrieved with Get Identification Verification endpoint from identificationUrl field of the response.
Currently only externalVerifier = WEB_ID and identificationType = VIDEO_IDENT is supported.
The legal name of the vendor/company performing the identification for this natural person
Method used to identify the customer
OK
Bad Request
Get Identification Verifications
String value used for pagination
Maximum number of items to return
20OK
Bad Request
Get Identification Verification
OK
Bad Request
Create new natural person type customer
Identifier for the associated Natural Person.
Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic
OK
Bad Request
Conflict
Update existing natural person type customer
Unique customer identification number in UUID format
Annual income net
Available assets
Natural person last name
Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic
Accepted
Bad Request
No content
Get natural person type customer
Unique customer identification number in UUID format
OK
Bad Request
Not Found
Assign natural persons the role of authorized proxy.
Identifier of the customer, joint person customer or legal entity customer, who will be managed by the proxy.
IDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).
Defines the period of validity of the power of proxy.
Only mandatory for proxyType SIGNATORY
Defines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:
- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES
- JOINT: If soleSignatureAuthorized of the legal representative = NO
Only mandatory for proxyType GUARDIAN.
Specifies the type of custody associated with the guardian.
SINGLE_CUSTODY: Indicates that only one guardian holds legal and physical custody of the child.JOINT_CUSTODY: Indicates that the custody of the child is shared between two guardians, typically implying both have legal rights concerning the child's upbringing.
OK
Bad Request
Conflict
Get a list of proxies.
String value used for pagination
Maximum number of items to return
20Proxy type filter
Defines the period of validity of the power of proxy.
Proxy status Filter
proxy search text, the search will be performed on the following fields: name of natural person, proxyId, customerId, naturalPersonId
Unique customer identification number in UUID format
Unique natural person identification number in UUID format
IDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).
OK
Bad Request
Update proxy
Unique proxy identification number in UUID format
Document ID in UUID format for those params where a document upload is required (scopeType, custodyType)
OK
No content
Bad Request
No content
Create new joint person customer
Annual income net
Available assets
Identifier for the first Natural Person
Identifier for the second Natural Person
OK
Bad Request
Conflict
Update existing joint person type customer
Unique customer identification number in UUID format
Annual income net
Available assets
Accepted
Bad Request
No content
Get joint person type customer
Unique customer identification number in UUID format
OK
Bad Request
Not Found
Creates a new beneficial owner
Path Parameter:
customerId: The ID of the customer to whom the beneficial owner will be assigned.
Payload:
Details for the new beneficial owner, such as first name, last name, etc.
Upon successful execution, a new beneficial owner will be created and stored, independent of any existing customer records.
The UUID of the customer for whom the beneficial owner will be designated.
All first names of the person according to the identification document
^\S+( \S+)*$Natural person last name
Location
Country code in ISO 3166-1 alpha-2 standard
FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.).
Indication of the type of beneficial owner:
In the context of legal entity customers:
REAL_UBO_25 = person who holds more than 25% of the company shares
FICTIVE_UBO = Legal Representative, if no person exists who holds more than 25% of the company shares
Only mandatory if boType = REAL_UBO_25
Only mandatory if boType = REAL_UBO_25
Indication of whether this person is a controlling person under FATCA.
TRUE = if fatcaClassification = PASSIVE_NFE
OK
Bad Request
Conflict
Get beneficial owners of a customer
The UUID of the customer for whom the beneficial owner will be designated.
String value used for pagination
Maximum number of items to return
20beneficial owner status filter
Beginning of the range. Beneficial owner create date time is after this parameter.
End of the range. Beneficial owner create date time is before this parameter.
OK
Bad Request
Get Beneficial Owner
Get beneficial owner of a customer
The UUID of the customer for whom the beneficial owner will be designated.
The UUID of the beneficial owner
OK
Bad Request
Not Found
Update Beneficial Owner
Update existing beneficial owner
The UUID of the customer for whom the beneficial owner will be designated.
The UUID of the beneficial owner
All first names of the person according to the identification document
^\S+( \S+)*$Natural person last name
Location
Country code in ISO 3166-1 alpha-2 standard
FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.).
Indication of the type of beneficial owner:
In the context of legal entity customers:
REAL_UBO_25 = person who holds more than 25% of the company shares
FICTIVE_UBO = Legal Representative, if no person exists who holds more than 25% of the company shares
Only mandatory if boType = REAL_UBO_25
Indication of whether this person is a controlling person under FATCA.
TRUE = if fatcaClassification = PASSIVE_NFE
Accepted
Bad Request
No content
Last updated