Authentication v3

Request v3 Access Token

Changed on Nov 6, 2026

The OAuth v3 token request authenticates your API message sent in either JSON or XML formats and responds with an access token.

post/authenticationservices/v3/oauth/token

Request

Base URL
https://tts.sandbox.apib2b.citi.com/citiconnect/sb
Auth
HTTP basic
TypeScript
https://skmtc.dev/citi/apis/authentication-services/docs/authenticationservices/v3/oauth/token/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Content-Typestring required

Supports "application/xml" and "application/json".

Authorizationstring required

The authorization will include "Basic" followed by a single space, followed by the Base64 encoded value of the APIm client_id & secret key.

In the above example, the client_id is 1234a5b6-cde7-8f90-12gh-345ij6789012 & secret key is abcdefghijklmnop.

The Base64 value after appending by adding “:” in between will be “MTIzNGE1YjYtY2RlNy04ZjkwLTEyZ2gtMzQ1aWo2Nzg5MDEyOmFiY2RlZmdoaWprbG1ub3A=”.

Request body

Example request

{
  "oAuthToken": {
    "grantType": "client_credentials",
    "scope": "/authenticationservices/v1"
  }
}

Response

token_typestring

The default value will be “Bearer”.

access_tokenstring

Contains the OAuth Token that will be used for authenticating successive API calls.

expires_instring

The expiry time limit of the OAuth Token in seconds.

scopestring

The version scope of the authentication call. The value will be the same for all the API versions.

Changes

Nov 6, 202632b7b9eec629 Revision changes
- breaking
  the response's body type changed from object to no type for status (media type: application/json)
- breaking
  the response's body type changed from object to no type for status (media type: application/xml)
- breaking
  removed the required property from the response with the status (media type: application/json)
- breaking
  removed the required property from the response with the status (media type: application/xml)
- breaking
  removed the required property from the response with the status (media type: application/json)
- breaking
  removed the required property from the response with the status (media type: application/xml)
- breaking
  removed the required property from the response with the status (media type: application/json)
- breaking
  removed the required property from the response with the status (media type: application/xml)
- breaking
  removed the required property from the response with the status (media type: application/json)
- breaking
  removed the required property from the response with the status (media type: application/xml)
- breaking
  removed the required property from the response with the status (media type: application/json)
- breaking
  removed the required property from the response with the status (media type: application/xml)
- breaking
  removed the required property from the response with the status (media type: application/json)
- breaking
  removed the required property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- info
  the endpoint scheme security Basic_Authentication was added to the API
- info
  the endpoint scheme security Basic Authentication was removed from the API
- info
  api tag Authentication v3 added
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)

Operation history