---
title: "Obtain a service token status"
method: POST
path: "/oauth/introspect"
tags: ["Authentication"]
---

# Obtain a service token status

`POST /oauth/introspect`

## Request

- Base URL: `https://account-name.talkdeskid.com`
- URL: `https://account-name.talkdeskid.com/oauth/introspect`
- Auth: none declared

Obtain a service token status

## Request body `application/x-www-form-urlencoded`

- object
  - `token` string, required: Token credential information

## Response `200`

Document containing comprehensive metadata about the token, including whether the token is currently active.

- object
  - `kid` string, required: The identification number for the key pair used to sign the API response
  - `sig` string, required: The signature value obtained from the base64 URL encoded JSON metadata of the "token_introspection" response parameter. It is calculated using the signature algorithm specified in the OAuth certificate endpoint. The calculation involves applying the designated signature algorithm on the base64 URL encoded "token_introspection" payload and then base64 URL encoding the result. E.g - "base64UrlEncode(HMACSHA256(base64UrlEncode(tokenIntrospectionPayload)))"
  - `token_introspection` object, required
    - `active` boolean, required: Indicator of whether or not the presented token is currently active
    - `iss` string: The issuer of this token. This will correspond to the Talkdesk ID subdomain for the token's account
    - `aud` string: The intended audience for this token. This will correspond, for example, to the API Gateway's URL for the corresponding environment
    - `exp` integer: Timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire
    - `nbf` integer: Timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before
    - `iat` integer: Timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued
    - `cid` string: Client identifier for the client that requested this token
    - `aid` string: The Account ID of the Talkdesk Account this token belongs to
    - `scp` string: A space-separated list of scopes (URL encoded) the client requested access to
    - `reg` string: Cloud provider region where the token was generated
    - `psn` 'INTERNAL' | 'CUSTOMER' | 'PARTNER' | 'INTERNAL_RESTRICTED': The persona of the client

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/talkdesk/apis/authentication-api.md) - [All operations](https://skmtc.dev/talkdesk/apis/authentication-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talkdesk/apis/authentication-api/revisions/cff3380d1fcc?raw)