Physical Users
A Physical User is a human individual, identified by a first name, last name, date of birth, address, etc. They have a userTypeId of 1.
Creation
Parameters
Below are the necessary parameters to create Physical Users.
While some parameters might not be required by the API, they are necessary when it comes to the KYC validation of the user, so they should be collected from the creation (or you may have to update the user information later on).
| Attribute | Type | Description |
|---|---|---|
userTypeId | integer | Must be 1 for physical users. |
specifiedUSPerson | integer | Indicates if the user is a US Person. |
email | string | The email of the user, which must be valid and can't exceed 200 characters. |
title (required for KYC) | string | The title of the user, which can be one of the following: M (mr), MME (mrs), or MLLE (miss). |
firstname (required for KYC) | string | The user's first name. |
lastname (required for KYC) | string | The user's last name. |
birthday (required for KYC) | string | The user's birth date. Format YYYY-MM-DD |
placeOfBirth (required for KYC) | string | The user's place of birth. |
birthCountry (required for KYC) | string | The user's birth country (format ISO 3166-1 alpha-2) |
nationality (required for KYC) | string | The user's nationality (format ISO 3166-1 alpha-2) |
mobile | string | The user's mobile phone number, in international E.164 format. |
address{1-3} (required for KYC) | string | The user's postal address. The max value for each address line is 150 characters. If you're issuing cards, see the Data Formats article for information on further limitations. |
postcode (required for KYC) | string | The user's address postcode. |
city (required for KYC) | string | The user's address city. |
country (required for KYC) | string | The user's address country (format ISO 3166-1 alpha-2) |
phone (required for KYC) | string | The User phone number in international E.164 format. |
occupationType | string | Type of occupation of the user, among the following: self_employed, public_sector_employees, private_sector_employees, retired_people_and_students, without_any_professional_activity |
incomeRange (required for KYC) | string | Annual income range in k€. Ranges are the following: 0-18, 19-23, 24-27, 28-35, 36-56, and 57-*. |
personalAssets | string | The User personal assets range in k€. Ranges are the following: 0-2, 3-22, 23-128, 129-319, 320-464, and 465-. |
distributionCountry (required for KYC if) | string | The country in which the end user is using your services. This field is only required when you operate in multiple countries. |
Information – Refer to your KYC Form for declarative data
Declarative data to submit depends on the type of user, the country you're operating in, the regulations linked to your use case, etc. Treezor Compliance team provides you with your KYC Form so you know what needs to be submitted.
Request example
bash
curl -X POST {baseUrl}/v1/users \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
-d '{payload}'Here is an example of {payload}:
json
{
"userTypeId": 1,
"specifiedUSPerson": 0,
"firstname": "Alex",
"lastname": "Oak",
"birthday": "1982-05-31",
"placeOfBirth": "Edgewood",
"birthCountry": "FR",
"nationality": "FR",
"email": "alex.oak@example.com",
"address1": "33 rosewood road",
"postcode": "75017",
"city": "Paris",
"country": "FR",
"phone": "+3311111111"
}Returns a User object, with both its kycLevel and kycReview initially set to NONE. The user now needs to go through the KYC validation process.
json
{
"users": [
{
"userId": 8327278,
"userTypeId": 1,
"userStatus": "VALIDATED",
"userTag": "",
"parentUserId": 0,
"parentType": "",
"controllingPersonType": 0,
"employeeType": 0,
"specifiedUSPerson": 0,
"title": "",
"firstname": "Alex",
"lastname": "Oak",
"middleNames": "",
"birthday": "1982-05-31",
"email": "alex.oak@example.com",
"address1": "33 rosewood road",
"address2": "",
"postcode": "75017",
"city": "Paris",
"state": "",
"country": "FR",
"countryName": "France",
"distributionCountry": null,
"phone": "+3311111111",
"mobile": "",
"nationality": "FR",
"nationalityOther": "",
"placeOfBirth": "Edgewood",
"birthCountry": "FR",
"occupation": "",
"incomeRange": "",
"legalName": "",
"legalNameEmbossed": "",
"legalRegistrationNumber": "",
"legalTvaNumber": "",
"legalRegistrationDate": "0000-00-00",
"legalForm": "",
"legalShareCapital": 0,
"entityType": null,
"legalSector": "",
"legalAnnualTurnOver": "",
"legalNetIncomeRange": "",
"legalNumberOfEmployeeRange": "",
"effectiveBeneficiary": 0,
"kycLevel": 0,
"kycReview": 0,
"kycReviewComment": "",
"isFreezed": 0,
"isFrozen": null,
"language": "",
"optInMailing": null,
"sepaCreditorIdentifier": "",
"taxNumber": "",
"taxResidence": "",
"position": "",
"personalAssets": "",
"createdDate": "2023-10-23 12:28:00",
"modifiedDate": "0000-00-00 00:00:00",
"walletCount": 0,
"payinCount": 0,
"totalRows": "1",
"activityOutsideEu": null,
"economicSanctions": null,
"residentCountriesSanctions": null,
"involvedSanctions": null,
"entitySanctionsQuestionnaire": null,
"address3": null,
"timezone": null,
"occupationType": "",
"isOnStockExchange": 0,
"secondaryAddress1": "",
"secondaryAddress2": "",
"secondaryAddress3": "",
"secondaryPostcode": "",
"secondaryCity": "",
"secondaryState": "",
"secondaryCountry": "",
"clientId": "945198",
"sanctionsQuestionnaireDate": null,
"codeStatus": "110009",
"informationStatus": "",
"legalSectorType": "",
"sourceOfFunds": ""
}
]
}Anonymous Users
An Anonymous User is a user only represented by its unique email address. No other declarative data is required, nor is the mandatory KYC validation.
This specific user is intended for limited use cases such as:
- Gift cards which are not associated to a specific user.
- Bulk card creation, where the anonymous user is used as a placeholder until the card can be assigned to its owner.
Information – Anonymous users have limited usage (not KYC-validated)
- Payment, withdrawal, and transfer limits are highly restricted.
- The transaction can be refused if an address verification (AVS) occurs.
- 3DS verifications are rejected as no secondary means of validation are available.
Parameters
| Attribute | Type | Description |
|---|---|---|
userTypeId | integer | Must be 1 for physical users. |
specifiedUSPerson | integer | Indicates if the user is a US Person. |
email | string | The email of the anonymous user, which must be valid and can't exceed 200 characters. |
Tip – User address must be unique even for bulk card creation
When generating a batch of Cards in advance and associating them to Anonymous Users, your can generate random and fictitious email addresses
Creation
bash
curl -X POST {baseUrl}/v1/users \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
-d '{payload}'Here is an example of {payload}:
json
{
"userTypeId": 1,
"specifiedUSPerson": 0,
"email": "anonymous@example.com"
}Returns a User object if successful:
json
{
"users": [
{
"userId": "<integer>",
"userTypeId": 1,
"userStatus": "<string>",
"specifiedUSPerson": 0,
"email": "anonymous@example.com",
// [...] some attributes are hidden
}
]
}Shareholders and Legal representatives
Among the Physical Users that can be created in Treezor, there is the case of the Shareholders and the Legal Representatives of a company.
These specific physical users, identified with the parentType attribute:
- Are attached to the Legal entity (the company) with a parent-children relation.
- May require more documents and declarative data to be verified.