Checks that a sell onboarding URL was built by this endpoint for the authenticated client and has not been tampered with. The checkout calls it with the parameters and signature the URL was opened with before acting on them: 204 when they are genuine, ER336 when they are not.

POST

/api/v2/sell/onboarding/verify

Authorizations

• Client

Request Body ^required

object

signature

required

The signature parameter of the onboarding URL.

string

nullable

Example

afnsifuhwaensdkfnsdsir9324989r3ssd

identifier

The identifier parameter of the onboarding URL, unchanged.

string

nullable

returnUrl

The returnUrl parameter of the onboarding URL, unchanged.

string

nullable

locale

The locale parameter of the onboarding URL, unchanged.

string

nullable

payoutMethod

The payoutMethod parameter of the onboarding URL, unchanged (comma-separated).

string

nullable

kycShareToken

The kycShareToken parameter of the onboarding URL, unchanged.

string

nullable

Responses

204

The onboarding URL is genuine.

400

A list of possible errors for this endpoint.

object

code

required

string

Allowed values: ER331 ER336 ER800 ER801 ER802 ER803 ER805 ER806 ER999

message

required

string

solution

required

string

Example

{
  "errors": {
    "ER331": {
      "code": "ER331",
      "message": "Secret not set",
      "solution": "Please contact support for assistance."
    },
    "ER336": {
      "code": "ER336",
      "message": "Signature is invalid.",
      "solution": "Provide a valid Signature."
    },
    "ER800": {
      "code": "ER800",
      "message": "Authorization token is invalid.",
      "solution": "Provide a valid authorization token."
    },
    "ER801": {
      "code": "ER801",
      "message": "Authorization token has expired.",
      "solution": "Request a new authorization token."
    },
    "ER802": {
      "code": "ER802",
      "message": "Authorization token not found.",
      "solution": "Provide an authorization token."
    },
    "ER803": {
      "code": "ER803",
      "message": "Multiple authorization methods used.",
      "solution": "Use exactly one authorization method."
    },
    "ER805": {
      "code": "ER805",
      "message": "API key is invalid.",
      "solution": "Provide a valid API key."
    },
    "ER806": {
      "code": "ER806",
      "message": "API key not found.",
      "solution": "Provide an API key."
    },
    "ER999": {
      "code": "ER999",
      "message": "A general error has occurred. Please contact our support team.",
      "solution": "Contact our support team."
    }
  }
}