Modifications

Users' declarative data evolve as they use your services. It's not uncommon to have to update the user's address or contact information for instance.

For KYC-validated Users, most modifications trigger a new KYC review.

Tip – Attribute updates that don't result in KYC review

address3, phone, mobile, activityOutsideEu, economicSanctions, residentCountriesSanctions, involvedSanctions, timezone.

Updating

To update a user, you can use the following request.

CURL

curl -X PUT {baseUrl}/v1/users/{userId} \
	--header 'Authorization: Bearer {accessToken}' \
	--header 'Content-Type: application/json' \
	-d '{payload}'

Here is a {payload} example:

JSON

{
	"address1":"new address",
	"address2":"new address continuated",
	"postcode":"75001",
	"city":"Paris"
}

Returns the updated User object with the modified fields.

JSON

{
	"users": [
        {
            "userId": 100147235,
            "userTypeId": 1,
            "userStatus": "VALIDATED",
            "userTag": "user test Treezor",
            "parentUserId": 0,
            "parentType": "",
            "controllingPersonType": 0,
            "employeeType": 0,
            "specifiedUSPerson": 0,
            "title": "M",
            "firstname": "Alex",
            "lastname": "Oak",
            "middleNames": "",
            "birthday": "1982-05-31",
            "email": "190john.smith725@test.com",
			"address1":"new address",
			"address2":"new address continuated",
			"postcode":"75001",
			"city":"Paris",
			// [...] some attributes are hidden
        }
    ]
}

Deletion

For legal reasons, Users cannot be deleted. They are permanently “Canceled” instead.

Prerequisites – Wallet Balance must be 0

Before cancelling users, make sure that all of their wallets have a balance of zero.

To cancel a User you can use the following request, and provide an origin which can either be:

• OPERATOR– When you are at the origin of the deactivation.
• USER – When the end user is at the origin of the deactivation.

CURL

curl -X DELETE {baseUrl}/v1/users/{userId} \
	--header 'Authorization: Bearer {accessToken}' \
	--header 'Content-Type: application/json' \
	-d '{payload}'

Here is an example of {payload}:

JSON

{
    "origin": "OPERATOR"
}

Returns a User object if successful, with the userStatus set to CANCELED:

JSON

{
    "users": [
        {
            "userId": 8327278,
            "userTypeId": 1,
            "userStatus": "CANCELED",
            "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",
            "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": 1,
            "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,
            "address3": null,
            "timezone": null,
            "occupationType": "",
            "isOnStockExchange": 0,
            "secondaryAddress1": "",
            "secondaryAddress2": "",
            "secondaryAddress3": "",
            "secondaryPostcode": "",
            "secondaryCity": "",
            "secondaryState": "",
            "secondaryCountry": "",
            "clientId": "945198",
            "sanctionsQuestionnaireDate": null,
            "codeStatus": "110009",
            "informationStatus": "",
            "legalSectorType": "",
            "sourceOfFunds": ""
        }
    ]
}