Off-boarding user

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.

SecuritybearerAuth
Request
path Parameters
User-ID
required
string <uuid>

User ID

Request Body schema: application/json

The Off-boarding user request.

reason
required
string

The off-boarding reason

Enum: "business_relation_end" "compliance" "deceased" "dunning_unsuccessful" "insolvency" "mentally_incapacitated" "other"
first_notice_of_termination
string

The first notice of termination

country_of_residence
string

Residence country code in Alpha-2 ISO 3166 format

liquidate_assets
boolean

Recommendation on whether to liquidate the assets as part of the off-boarding process

Responses
200

User off-boarding requested

400

Error

401

Invalid user

403

Error code

422

Error

429

Too Many Requests

500

Error

503

Maintenance or Service unavailable

post/v1/users/{User-ID}/off-boarding
Request samples
application/json
{
  • "reason": "other",
  • "first_notice_of_termination": "2021-04-25",
  • "country_of_residence": "AT",
  • "liquidate_assets": true
}
Response samples
application/json
{
  • "data": {
    }
}