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 type	Field	Usage
Freeze	isFrozen	Allows 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 Freeze	Not exposed	Freezes 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.

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.

Operation	Type	isFrozen	IsLegalFrozen
Card transactions	Payout
Emitted wallet-to-wallet transfers	Payout
Received wallet-to-wallet transfers	Payin
Emitted SEPA Credit Transfers (including SCTE Inst)	Payout
Received SEPA Credit Transfers (including SCTR Inst)	Payin
Emitted SEPA Direct Debit	Payin
Received SEPA Direct Debit	Payout
Card acquiring	Payin
Check cashing	Payin

Operations such as SEPA Recalls & RROs, as well as Refunds may be enabled or not depending on the situation, and may be manually 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

Attribute	Type	Description
isFrozen	integer	Indicates whether to freeze or unfreeze the user. 0 – The User isn’t frozen 1 – The User is frozen
comment	string	Explanation 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.

CURL

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.

Legal Freeze

This endpoint is only available if you’re a Regulated Institution. If you’re not, you may contact Treezor for any action relative freeze and unfreeze a user's assets.

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.