Off-boarding user

POST

/v1/users/{User-ID}/off-boarding

Calling this endpoint initiates the creation of an off-boarding request, which undergoes an initial review process.
It's important to note that user off-boarding and asset liquidation do not occur automatically upon receipt of the request; instead, all requests are subject to manual review.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

User off-boarding requested

Body

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

🔴503

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test.whitelabel.bitpanda.com/v1/users//off-boarding' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "business_relation_end",
    "first_notice_of_termination": "2021-04-25",
    "country_of_residence": "AT",
    "liquidate_assets": true
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "6d7653c6-8ea5-4096-a30e-c86d8eee7d9d",
        "reason": "business_relation_end"
    }
}

Get user details

Inactivate user