Initiates a verification upgrade for the authenticated user. The response envelope mirrors GET /api/v2/buy/{id}/identification/liveness — `name`, `type`, `status`, `data` — and adds `currentLevel` and `nextLevel`. `data` carries the provider-specific payload the WebSDK needs (e.g. an `accessToken` for SumSub).

POST

/api/v2/user/upgrade

Authorizations

• Client
• User

Responses

200

Upgrade flow initiated; returns the provider payload the WebSDK needs.

object

currentLevel

required

The verification level the user currently holds.

string

Example

hero

nextLevel

The verification level the upgrade flow targets, or null when no upgrade flow is available for this user.

string

nullable

Example

satoshi

upgrade

One of:

object

object

access_token

string

status

string

provider

string

400

A list of possible errors for this endpoint.

object

code

required

string

Allowed values: ER700 ER701 ER702 ER703 ER704 ER705 ER706 ER707 ER708 ER709 ER999

message

required

string

solution

required

string

Example

{
  "errors": {
    "ER700": {
      "code": "ER700",
      "message": "User authorization token not found.",
      "solution": "Provide a user authorization token."
    },
    "ER701": {
      "code": "ER701",
      "message": "User authorization token has expired.",
      "solution": "Request a new authorization token, or refresh the token."
    },
    "ER702": {
      "code": "ER702",
      "message": "User authorization token is invalid.",
      "solution": "Provide a valid user authorization token."
    },
    "ER703": {
      "code": "ER703",
      "message": "User identifier does not belong to the user in the user authorization token.",
      "solution": "Provide a valid user identifier, or remove the user identifier header."
    },
    "ER704": {
      "code": "ER704",
      "message": "No user identifier found in headers.",
      "solution": "Provide a valid user identifier, or use the user/password authentication mechanism to request a user token and send that."
    },
    "ER705": {
      "code": "ER705",
      "message": "User identifier is not linked to a user.",
      "solution": "Provide a valid user identifier, link this user identifier to a user account, or use the user/password authentication mechanism."
    },
    "ER706": {
      "code": "ER706",
      "message": "User identifier is invalid.",
      "solution": "Provide a valid user identifier, a unique identifier string for the user account that is not already in use."
    },
    "ER707": {
      "code": "ER707",
      "message": "User identifier is invalid.",
      "solution": "Please provide an identifier, consisting of 36 - 255 characters, numeric or alphanumeric only."
    },
    "ER708": {
      "code": "ER708",
      "message": "There is a pending document for this side.",
      "solution": "Wait for the pending document to be reviewed."
    },
    "ER709": {
      "code": "ER709",
      "message": "User not found, or user has been deleted.",
      "solution": "Provide a valid user identifier."
    },
    "ER999": {
      "code": "ER999",
      "message": "A general error has occurred. Please contact our support team.",
      "solution": "Contact our support team."
    }
  }
}