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	Deprecated, use `occupationCategory` instead.
`occupationCategory` (required for KYC)	integer	Type of occupation of the user. See list.
`incomeRange` (required for KYC)	string	Deprecated, use `monthlyIncomeRange` instead.
`monthlyIncomeRange` (required for KYC)	integer	Net monthly income of the user. See list.
`personalAssets`	string	Deprecated, use `personalAssetsRange` instead.
`personalAssetsRange`	integer	The personal assets of the user. See list.
`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 listing what needs to be submitted.

Occupation Category (`occupationCategory`)

Below is the list of values for the occupation category.

Value	Label
`1`	Pupil, student or apprentice
`2`	Beneficiaries of unemployment assistance
`3`	Without professional activity
`4`	Executive and Intellectual Profession in the private sector
`5`	Employee in the private sector
`6`	Business owner
`7`	Executive and Intellectual Profession in the public sector
`8`	Employee and Officer in the public sector
`9`	Farmer
`10`	Self-employed
`11`	Craftsman
`12`	Shopkeeper and related professions
`13`	Freelance profession
`14`	Medical freelance professions (or medical practitioners)
`15`	Retired

Personal Assets Range (`personalAssetsRange`)

Below is the list of values for the personal assets range.

Value	Label
`0`	None
`1`	0 to 15 000 Euros
`2`	From 15 001 Euros to 50 000 Euros
`3`	From 50 001 Euros to 150 000 Euros
`4`	From 150 001 Euros to 350 000 Euros
`5`	From 350 001 Euros to 750 000 Euros
`6`	From 750 001 Euros to 1 500 000 Euros
`7`	Greater than 1 500 000 Euros

Monthly Income Range (`monthlyIncomeRange`)

Below is the list of values for the net monthly income range.

Value	Label
`1`	0 - 999 Euros per month
`2`	1000 - 1800 Euros per month
`3`	1801 - 3500 Euros per month
`4`	3501 - 5000 Euros per month
`5`	5001 - 6500 Euros per month
`6`	6501 - 10000 Euros per month
`7`	Greater than 10000 Euros per month

Request example

CURL

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

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

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": "Paris",
            "birthCountry": "FR",
            "occupation": "",
            "incomeRange": "0-18",
            "legalName": "",
            "legalNameEmbossed": "",
            "legalRegistrationNumber": "",
            "legalTvaNumber": "",
            "legalRegistrationDate": "0000-00-00",
            "legalForm": "",
            "legalShareCapital": 0,
            "entityType": 0,
            "legalSector": "",
            "legalAnnualTurnOver": "",
            "legalNetIncomeRange": "",
            "legalNumberOfEmployeeRange": "",
            "effectiveBeneficiary": 0,
            "kycLevel": 0,
            "kycReview": 0,
            "kycReviewComment": "",
            "isFreezed": 0,
            "isFrozen": null,
            "language": "",
            "optInMailing": null,
            "sepaCreditorIdentifier": "",
            "taxNumber": "",
            "taxResidence": "",
            "position": "",
            "personalAssets": "",
            "createdDate": "2024-11-13 07:40:10",
            "modifiedDate": "0000-00-00 00:00:00",
            "walletCount": 0,
            "payinCount": 0,
            "totalRows": "1",
            "activityOutsideEu": 0,
            "economicSanctions": 0,
            "residentCountriesSanctions": 0,
            "involvedSanctions": 0,
            "address3": null,
            "timezone": null,
            "occupationType": "",
            "isOnStockExchange": 0,
            "secondaryAddress1": "",
            "secondaryAddress2": "",
            "secondaryAddress3": "",
            "secondaryPostcode": "",
            "secondaryCity": "",
            "secondaryState": "",
            "secondaryCountry": "",
            "clientId": "929252",
            "sanctionsQuestionnaireDate": null,
            "codeStatus": "110009",
            "informationStatus": "",
            "legalSectorType": "",
            "sourceOfFunds": "",
            "distributionCountry": null,
            "entitySanctionsQuestionnaire": 0,
            "occupationCategory": 5,
            "personalAssetsRange": 2,
            "monthlyIncomeRange": 2
        }
    ]
}

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

CURL

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

json

{
    "userTypeId": 1,
    "specifiedUSPerson": 0,
    "email": "anonymous@example.com"
}

Returns a User object if successful:

JSON

json

{
	"users": [
		{
			"userId": "<integer>",
			"userTypeId": 1,
			"userStatus": "<string>",
			"specifiedUSPerson": 0,
			"email": "anonymous@example.com",
			// [...] some attributes are hidden
		}
	]
}

Self-employed Users

Self-employed individuals are a specific case since they work for their own account. That makes them physical users (userTypeId=1) with many attributes of a legal entity. Therefore:

The attributes required for /v1/users/{userId}/Kycreview cumulates the ones for the creation of a physical user and legal entities.
Declarative data to submit is specific, you must refer to the KYC Form provided by Treezor.

Here are a few specificities regarding data to provide.

Attribute	Type	Description
`userTypeId`	integer	Must be `1` for self-employed users.
`email`	string	The email of the user, which must be valid and can't exceed 200 characters.
`specifiedUSPerson`	integer	Indicates if the user is a US Person.
`legalForm`	integer	Must be `1000` for self-employed users.
`address{1-3}` (required for KYC)	string	The user's professional postal address. See the Data Formats article for information on limitations.
`secondaryAddress{1-3}` (required for KYC)	string	The user's personal postal address. See the Data Formats article for information on limitations.

In addition, a self-employed user must answer the Sanctions & Embargo questionnaire and provide their Tax residence.

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.

Physical Users ​

Creation ​

Parameters ​

Occupation Category (occupationCategory) ​

Personal Assets Range (personalAssetsRange) ​

Monthly Income Range (monthlyIncomeRange) ​

Request example ​

Anonymous Users ​

Parameters ​

Creation ​

Self-employed Users ​

Shareholders and Legal representatives ​

Physical Users

Creation

Parameters

Occupation Category (`occupationCategory`)

Personal Assets Range (`personalAssetsRange`)

Monthly Income Range (`monthlyIncomeRange`)

Request example

Anonymous Users

Parameters

Creation

Self-employed Users

Shareholders and Legal representatives