CheckID
CustomersPartners
VIEN
Contact
Home/Developer Platform/Access Token
DEVELOPERS · CHECKID

Access Token

Obtain a short-lived access token before invoking E-Identity APIs.

Talk to an expertDeveloper quick start
CONTRACTVersioned API / SDK
AUTHOAuth2 / environment
OUTPUTResponse · result code · evidence
SOURCE-DRIVEN REST CONTRACT

Get Access Token

Obtain a short-lived Bearer access token for subsequent CheckID API requests.

Source contractDigital Trusted Identity Service API And Kafka Specifications · V1.2.260123
GET/realms/{realm}/protocol/openid-connect/token
OAuth2 Client Credentials + Basic bootstrap token3.1 · Gets Access TokenSource p.10

Obtain a short-lived Bearer access token for subsequent CheckID API requests.

Open in API Explorer ↗
Field Type Presence Description
lang String O VN / EN
profile String O openid-connect-identity-assurance-1.0 by source default
external_id String O RP tracking identifier
REQUEST — redacted sampleNO PRODUCTION SECRET 
{
  "lang": "EN",
  "profile": "openid-connect-identity-assurance-1.0",
  "external_id": "demo-trace-001"
}
RESPONSEDOCUMENTED SHAPE 
{
  "status": 0,
  "message": "SUCCESSFULLY",
  "access_token": "<BEARER_TOKEN>",
  "token_type": "Bearer",
  "expires_in": 900,
  "dtis_id": "<DTIS_TRANSACTION_ID>"
}
Publication boundaryExamples use explicit placeholders; the website does not send requests to a production environment.
AUTHENTICATION JOURNEY

From integration credential to verification result

The source sample defines a 900-second access-token lifetime; subsequent requests use a Bearer token with the request-signing context.

Source contractSections 2 and 3.1 · OAuth2 Client Credentials + Gets Access Token
Integration CredentialsRP-issued integration context
→
OAuth2 Client CredentialsSigned HTTP request
→
Get Access TokenShort-lived Bearer token
→
Subject / ProcessIdentity verification lifecycle
→
Evidence / ResultCheckID ID · result · signed claims
API CONTRACT ·

Actual contract: Retrieve Token

CheckID API & Kafka Specifications V1.2.260123 §2.1.1

Method & path

POST /realms/{realm}/protocol/openid-connect/token

Purpose

OAuth2 Client Credentials token retrieval.

Authentication

Basic <CLIENT_ID:CLIENT_SECRET>

Source

CheckID API & Kafka Specifications V1.2.260123 §2.1.1

Classification

PUBLIC

Publication boundary

This page uses the operation extracted from CheckID API & Kafka Specifications V1.2.260123. Examples illustrate the published contract; required/conditional rules still need to be read with OpenAPI and the relevant partner specification. Placeholders are not real data.

Example request

{
  "grant_type": "client_credentials"
}

Example response

{
  "access_token": "<ACCESS_TOKEN>",
  "expires_in": 1800,
  "refresh_expires_in": 0,
  "token_type": "Bearer",
  "scope": "profile email"
}