Restricted Users ​

Introduction ​

The obligations placed on banking services providers aim to prevent the misuse of the financial system for illegitimate purposes, as stated by the anti-money laundering and countering the financing of terrorism (AML/CFT) rules.

In this context, Treezor may restrict the usage of the API to some Users to provide a compliant and secure banking ecosystem.

Types of User restrictions ​

There are 2 ways a user may be under restrictions:

Restriction typeFieldUsage
FreezeisFrozenAllows operational teams to block the user’s assets, preventing most payout operations from their wallets. This feature may be open for as an operational tool.
Legal FreezeNot exposedFreezes the user’s assets, preventing funds from being debited from their Wallets. Treezor freezes assets when the user is deemed unfit to use banking services based on AML/CFT regulations. This feature is only open to Treezor.
Warning icon

Important – Don’t share their blocked status with end users

Due to legal implications, you mustn’t let your users know if their assets are frozen.

Blocked operations ​

When a User is blocked, some operations on their Wallets are no longer possible while others are still permitted.

Below is the list of available operations by user restriction status.

OperationTypeisFrozenIsLegalFrozen
Card transactionsPayoutno crossno cross
Emitted wallet-to-wallet transfersPayoutno crossno cross
Received wallet-to-wallet transfersPayinyes checkmarkyes checkmark
Emitted SEPA Credit Transfers
(including SCTE Inst)		Payoutno crossno cross
Received SEPA Credit Transfers
(including SCTR Inst)		Payinyes checkmarkyes checkmark
Emitted SEPA Direct DebitPayinyes checkmarkyes checkmark
Received SEPA Direct DebitPayoutyes checkmarkno cross
Card acquiringPayinyes checkmarkyes checkmark
Check cashingPayinyes checkmarkyes checkmark

Operations such as SEPA Recalls & RROs, as well as Refunds may be enabled or not depending on the situation, and may be manualy checked by Treezor teams prior to blocking.

Freeze ​

When a User is blocked with the isFrozen status, all payout operations except SDDR are forbidden while it’s still possible to credit their Wallet with payins.

Also, Treezor notifies you through a user.update webhook with the isFreezed field valued to 1 when a user is blocked.

Block a User ​

This endpoint is only available if you’re a Regulated Institution. If you’re not, you may contact Treezor for any action relative to blocking/unblocking users.

Parameters ​

AttributeTypeDescription
isFrozen integerIndicates whether to freeze or unfreeze the user.
  • 0 – The User isn’t frozen
  • 1 – The User is frozen
comment stringExplanation for the blocked status of the user. You can’t retrieve this value afterward.

Request ​

You can use the following request with the admin scope to freeze/unfreeze a user.

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

Here is an example of {payload}:

json
{
	"isFrozen":1,
	"comment":"Mandatory comment explaining the reason for freezing"
}

Returns the User object, with the corresponding isFrozen attribute updated accordingly.

This type of restriction is not available to you, only Treezor can freeze and unfreeze a user's assets this way.

When a User has the IsLegalFrozen status, all payout operations including SDDR are forbidden while it’s still possible to credit their Wallet with payins.

Treezor notifies you through a user.update webhook with the IsLegalFrozen field valued to 1.