Access tokens

Create an access token

Exchanges an auth token for an access token, which is what authorizes identity-scoped API calls.

Signing in returns an auth token that can only reach /identities and /access_token. Everything else (accounts, cards, transactions) needs the access token produced here.

When to call it

  • After a user signs in with a password or biometrics.
  • When a user with access to several identities switches between them. An access token authorizes one identity at a time, so switching means requesting another.
  • When the current access token expires.

Fields

identity chooses which identity the token authorizes. If the user has access to only one, it can be omitted; otherwise list the options with List linked identities first.

clientAssertion applies only to customers enabled for delegation, and is generated from the certificate linked to the Delegated API Client.

Token status

The response carries a status of STANDARD or STEPPED_UP. Some operations (creating cards and accounts, reading a card PIN, statements) require a stepped-up token. A fresh access token is STANDARD; raise it with Send a one-time password to step up a token and Verify.

post/access_token

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/access_token
  • Auth: one of:
    • HTTP bearer and API key in header api-key
    • API key in header api-key

Request body

clientAssertionstring

Generated using the certificate linked to the Delegated API Client. This feature is available only to customers that have been enabled with delegation functionality.

tokenstring

A short-lived one-time token to be exchanged for an access token. This token is used for identity verification and authorization purposes.

Example request

{
  "identity": {
    "type": "CONSUMER",
    "id": "123456789"
  }
}

Response

Success

tokenstring
status'STANDARD' | 'STEPPED_UP'

The token status, as follows:

  • STANDARD: it is a standard token.
  • STEPPED_UP: it is a stepped up token.

Example response

{
  "identity": {
    "type": "CONSUMER",
    "id": "123456789"
  },
  "credentials": {
    "type": "USER",
    "id": "987654321"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.