Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Platform
    Authentication
      AuthorizepostTokenpost/sts/api/revokepost/sts/api/introspectpost
    Platform operations
      Health Checkpost
SchemasError codes
powered by Zudoku
OAuth2 Security Token Service
OAuth2 Security Token Service

Authentication

Get a bearer token. Every other call on this portal needs one first.


Authorize

POST
https://devcard.sim-ant.com/SandBox/oAuth2
/sts/api/authorize

Initiates an OAuth/OpenAuth authorization request and returns the data required to continue the authorization flow. This operation validates the incoming authorization context (e.g., client identity, requested grant/response type, redirect URI, and scope) and, when applicable, issues an authorization code tied to the request. It also supports additional flow parameters such as state for CSRF protection and code_challange / PKCE-related inputs to harden public-client scenarios. On success, the response provides the redirect_uri, code, and state values needed by the client to complete the next step of the flow.

Authorize › Request Body

AuthorizeRequest
response_type
​string | null

Response Type - [Optional]

grant_type
​string | null

Grant Type - [Optional]

client_id
​string | null

Client Id - [Optional]

client_secret
​string | null

Client Secret - [Optional]

redirect_uri
​string | null

Redirect Uri - [Optional]

scope
​string | null

Scope - [Optional]

state
​string | null

State - [Optional]

code_challenge
​string | null

Code Challenge

code_challenge_method
​string | null

Code Challenge Method

action_id
​string | null

Action Id - [Optional]

Authorize › Responses

Success

AuthorizeResponse
redirect_uri
​string | null

Redirect Uri - [Optional]

code
​string | null

Code - [Optional]

state
​string | null

State - [Optional]

POST/sts/api/authorize
curl https://devcard.sim-ant.com/SandBox/oAuth2/sts/api/authorize \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "response_type": "response_type", "grant_type": "grant_type", "client_id": "client_id", "client_secret": "client_secret", "redirect_uri": "redirect_uri", "scope": "scope", "state": "state", "code_challenge": "code_challenge", "code_challenge_method": "code_challenge_method", "action_id": "action_id" }'
Example Request Body
{ "response_type": "response_type", "grant_type": "grant_type", "client_id": "client_id", "client_secret": "client_secret", "redirect_uri": "redirect_uri", "scope": "scope", "state": "state", "code_challenge": "code_challenge", "code_challenge_method": "code_challenge_method", "action_id": "action_id" }
json
Example Responses
{ "redirect_uri": "redirect_uri", "code": "code", "state": "state" }
json
application/json

Token

POST
https://devcard.sim-ant.com/SandBox/oAuth2
/sts/api/token

Exchanges valid credentials or artifacts for OAuth tokens according to the requested grant_type. Depending on the flow, the request can include user credentials, an authorization code, a refresh_token, or an assertion, alongside client_id / client_secret (and optionally code_verifier for PKCE). The service validates the client, verifies the grant-specific inputs, and enforces scope rules before issuing tokens. On success, it returns an access_token, token_type, expires_in, and optionally a refresh_token to enable session continuation without re-authentication.

Part of:

  • Journey 01 · Launching a new card product — step 1, Get an access token

  • Journey 01 · Launching a new card product — step 1, Get an access token

  • Journey 01 · Launching a new card product — step 1, Get an access token

Token › Request Body

TokenRequest
grant_type
​string | null

Grant Type - [Optional]

scope
​string | null

Scope - [Optional]

username
​string | null

User Id

password
​object

Password - [Optional]

code
​string | null

Code - [Optional]

redirect_uri
​string | null

Redirect Uri - [Optional]

refresh_token
​string | null

Refresh Token - [Optional]

assertion
​string | null

Assertion - [Optional]

client_id
​string | null

Client Id - [Optional]

client_secret
​string | null

Client Secret - [Optional]

code_verifier
​string | null

Code Verifier - [Optional]

attestation_token
​string | null

Attestation Token - [Optional]

Token › Responses

Success

TokenResponse
expires_in
​integer · int32 · required

Expires In - [Optional]

access_token
​string | null

Access Token - [Optional]

token_type
​string | null

Token Type - [Optional]

refresh_token
​string | null

Refresh Token - [Optional]

scope
​string | null

Scope

POST/sts/api/token
curl https://devcard.sim-ant.com/SandBox/oAuth2/sts/api/token \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "grant_type": "grant_type", "scope": "scope", "username": "username", "password": {}, "code": "code", "redirect_uri": "redirect_uri", "refresh_token": "refresh_token", "assertion": "assertion", "client_id": "client_id", "client_secret": "client_secret", "code_verifier": "code_verifier", "attestation_token": "attestation_token" }'
Example Request Body
{ "grant_type": "grant_type", "scope": "scope", "username": "username", "password": {}, "code": "code", "redirect_uri": "redirect_uri", "refresh_token": "refresh_token", "assertion": "assertion", "client_id": "client_id", "client_secret": "client_secret", "code_verifier": "code_verifier", "attestation_token": "attestation_token" }
json
Example Responses
{ "access_token": "access_token", "token_type": "token_type", "expires_in": 0, "refresh_token": "refresh_token", "scope": "scope" }
json
application/json

POST
https://devcard.sim-ant.com/SandBox/oAuth2
/sts/api/revoke

Revoke Token

Request Body

RevocationRequest
token
​string | null

Token

token_type_hint
​string | null

Token Type Hint

client_id
​string | null

Client Id

client_secret
​string | null

Client Secret

Responses

Success

RevocationResponse
POST/sts/api/revoke
curl https://devcard.sim-ant.com/SandBox/oAuth2/sts/api/revoke \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "token": "token", "token_type_hint": "token_type_hint", "client_id": "client_id", "client_secret": "client_secret" }'
Example Request Body
{ "token": "token", "token_type_hint": "token_type_hint", "client_id": "client_id", "client_secret": "client_secret" }
json
Example Responses
{}
json
application/json

POST
https://devcard.sim-ant.com/SandBox/oAuth2
/sts/api/introspect

Introspect Token

Request Body

IntrospectionRequest
token
​string | null

Token

token_type_hint
​string | null

Token Type Hint

client_id
​string | null

Client Id

client_secret
​string | null

Client Secret

Responses

Success

IntrospectionResponse
active
​boolean · required

Active

scope
​string | null

Scope

client_id
​string | null

Client Id

username
​string | null

Username

token_type
​string | null

Token Type

exp
​integer | null · int64

Exp

iat
​integer | null · int64

Iat

jti
​string | null

Jti

iss
​string | null

Iss

POST/sts/api/introspect
curl https://devcard.sim-ant.com/SandBox/oAuth2/sts/api/introspect \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "token": "token", "token_type_hint": "token_type_hint", "client_id": "client_id", "client_secret": "client_secret" }'
Example Request Body
{ "token": "token", "token_type_hint": "token_type_hint", "client_id": "client_id", "client_secret": "client_secret" }
json
Example Responses
{ "active": true, "scope": "scope", "client_id": "client_id", "username": "username", "token_type": "token_type", "exp": 0, "iat": 0, "jti": "jti", "iss": "iss" }
json
application/json

Platform operations