Revoke a Refresh Token

POST

/v1/oauth/revoke

Use this endpoint to revoke a Refresh Token if you suspect it has been compromised, effectively preventing its further use for authentication.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200

Success Response

This response does not have a body.

🟠422

🔴500

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test.whitelabel.bitpanda.com/v1/oauth/revoke' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_id": "partner",
    "client_secret": "secret12345",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Imx5ZGlhIiwiZXhwIjoxNjY0MDIzMzkyLCJuYmYiOjE2NjM5MzY5OTIsImlhdCI6MTY2MzkzNjk5MiwianRpIjoiY2UxZmFjMDEtNDhjZC00NWE4LWI3YjQtYTA2NDQxZTUwZWE4In0.ZYafj15LT5hrFXzWjtzZci1yvL9INKyv85FeGxUaRfE"
}'

Response Example

422 - Success

{
    "errors": [
        {
            "code": "the.client_id.field.is.required.",
            "title": "The client_id field is required."
        },
        {
            "code": "the.client_secret.field.is.required.",
            "title": "The client_secret field is required."
        },
        {
            "code": "the.refresh_token.field.is.required.",
            "title": "The refresh_token field is required."
        },
        {
            "code": "http.bad.request",
            "title": "Bad JSON received."
        },
        {
            "code": "refresh.token.unknown",
            "title": "Refresh token is unknown"
        },
        {
            "code": "refresh.token.invalid",
            "title": "Refresh token is invalid"
        },
        {
            "code": "credentials.invalid",
            "title": "client_id is unknown, wrong or there is a client_id/client_secret mismatch"
        },
        {
            "code": "header.content.type",
            "title": "Unsupported content type"
        }
    ]
}

Obtain a Refresh and Access Tokens

Create new user