Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Platform
    Authentication
      authorizeposttokenpostrevokepostintrospectpost
    Platform operations
      healthCheckpost
SchemasError codes
powered by Zudoku
OAuth2 Security Token Service
OAuth2 Security Token Service

Schemas


AuthorizeRequest

response_type
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

grant_type
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

client_id
​string · optional

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

client_secret
​string · optional

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

redirect_uri
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

scope
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

state
​string · optional

An OAuth2 parameter the client chooses and the server echoes; RFC 6749 sets no length and neither does any column here.

code_challenge
​string · optional

Code Challenge

A PKCE parameter, defined by RFC 7636 rather than by a column here.

code_challenge_method
​string · optional

Code Challenge Method

A PKCE parameter, defined by RFC 7636 rather than by a column here.

action_id
​string · optional

Chosen by the caller and echoed back; no column behind this API stores it.

AuthorizeResponse

redirect_uri
​string · optional
code
​string · optional
state
​string · optional

Error

transactionId
​string · optional

The platform's identifier for this call, for tracing it in the logs.

errorCode
​string · optional

The platform's own code for the error, and what to match on.

description
​string · optional

The error in words. errorCode is the part to match on; this is for a log or a screen.

message
​string · optional

The error in words. errorCode is the part to match on.

messageFormat
​string · optional

The message before its arguments were substituted in, which is what groups two errors that differ only by their values.

arguments
​array · optional

The values substituted into messageFormat.

propertyName
​string · optional

Which field of the request the error is about.

detail
​string · optional

More about the error than message carries, where there is more.

​array · optional

The individual problems, where one error stands for several.

isTechnicalError
​boolean · optional

Whether the failure is the platform's rather than the request's. A technical error is worth retrying; a business one is not.

exceptionType
​string · optional

The platform's internal exception class. Useful in a support conversation and not something to match on.

HealthCheckResponse

date
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
result
​string · optional

The outcome, as the downstream system words it.

IntrospectionRequest

token
​string · optional

Token

An OAuth2 token, whose form is the authorisation server's rather than a column's.

token_type_hint
​string · optional

Token Type Hint

An OAuth2 parameter, defined by RFC 7009 rather than by a column here.

client_id
​string · optional

Client Id

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

client_secret
​string · optional

Client Secret

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

IntrospectionResponse

active
​boolean · required
scope
​string · optional
client_id
​string · optional
username
​string · optional
token_type
​string · optional
exp
​integer · int64 · optional
iat
​integer · int64 · optional
jti
​string · optional
iss
​string · optional

RevocationRequest

token
​string · optional

Token

An OAuth2 token, whose form is the authorisation server's rather than a column's.

token_type_hint
​string · optional

Token Type Hint

An OAuth2 parameter, defined by RFC 7009 rather than by a column here.

client_id
​string · optional

Client Id

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

client_secret
​string · optional

Client Secret

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

RevocationResponse

SecureString

TokenRequest

grant_type
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

scope
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

username
​string · optional

User Id

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

password
​object · optional

The resource owner's password, for the password grant only. Defined by RFC 6749 rather than by this platform, and ignored by every other grant type.

code
​string · optional

An OAuth2 authorisation code. Its form is the authorisation server's rather than a column's.

redirect_uri
​string · optional

An OAuth2 parameter, defined by RFC 6749 rather than by a column here.

refresh_token
​string · optional

An OAuth2 token, whose form is the authorisation server's rather than a column's.

assertion
​string · optional

An OAuth2 assertion, whose form is the issuing party's rather than a column's.

client_id
​string · optional

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

client_secret
​string · optional

An OAuth2 parameter. Its form is the authorisation server's and is defined by RFC 6749 rather than by a column here.

code_verifier
​string · optional

A PKCE parameter, defined by RFC 7636 rather than by a column here.

attestation_token
​string · optional

Issued and checked by the attestation service; its form is that service's rather than a column's.

TokenResponse

expires_in
​integer · int32 · required
access_token
​string · optional
token_type
​string · optional
refresh_token
​string · optional
scope
​string · optional
On this page
  • AuthorizeRequest
  • AuthorizeResponse
  • Error
  • HealthCheckResponse
  • IntrospectionRequest
  • IntrospectionResponse
  • RevocationRequest
  • RevocationResponse
  • SecureString
  • TokenRequest
  • TokenResponse