Revoke a Refresh Token

REST API Endpoints

Overview

Auth Tokens

post

Obtain a Refresh and Access Tokens

post

Revoke a Refresh Token

User Administration

Individual Users

Businesses

User Files

Legal & Regulatory

Asset Oversight

Trading Capabilities

Trades

Swaps

Automated Orders

Portfolio Management

Smart Investment Features

Crypto Transfers

Crypto Staking

Savings Plans

Transactions Timeline

All

Trades

Swaps

Crypto Transfers

Non-User Initiated Transactions

Corporate Actions

Staking Transactions

Settlements

Reports

Tax Insights

Notification Events

Webhooks

Overview

Setting up Webhooks

Handling Webhooks events

User Updates Notifications

Corporate Actions Notifications

Crypto Transfers Notifications

Settlement Notifications

Non-user Initiated Transactions Notifications

Savings Plans Notifications

Crypto Actions Notifications

Automated Orders Notifications

WebSocket

Overview

Setting a Websocket

Websocket Server Documentation

Glossary

Key Terms and Definitions

Revoke a Refresh Token

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

Request

Request Body schema: application/json

Revoke Refresh Token

client_id required	string
client_secret required	string
refresh_token required	string The refresh token which you want to invalidate

Responses

200

Success Response

422

Error

429

Too Many Requests

500

Error

post/v1/oauth/revoke

Request samples

application/json

{"client_id": "partner",
"client_secret": "secret12345",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6Imx5ZGlhIiwiZXhwIjoxNjY0MDIzMzkyLCJuYmYiOjE2NjM5MzY5OTIsImlhdCI6MTY2MzkzNjk5MiwianRpIjoiY2UxZmFjMDEtNDhjZC00NWE4LWI3YjQtYTA2NDQxZTUwZWE4In0.ZYafj15LT5hrFXzWjtzZci1yvL9INKyv85FeGxUaRfE"
}

Response samples

application/json

{"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"
}
]
}