---
title: "Initialize a Vault Client SDK"
method: POST
path: "/token/client/init"
tags: ["Vault Display SDK"]
---

# Initialize a Vault Client SDK

`POST /token/client/init`

Fetch the necessary information to initialize Display cards SDK on your client.

## Request body

- union
  - object
    - `type` 'reveal', required — The type of client side elements that you need a configuration for `reveal`. Reveal allows you to securely display record fields stored in Payrails Vault, e.g. card data. This feature is only available by request and requires an approval by Payrails.
    - `auditData` string, required — Data required for an audit trail related to the request to display the fields. E.g. user ID, who requested to display data, reason, etc.
    - `record` union, required
      - object
        - `fields` string[] — Record field types allowed for display. Possible fields are depended on a record type, e.g. for record type `card` it can be `cardNumber`, `expiryMonth`, `expiryYear`, `securityCode`, `holderName`.
        - `id` string, uuid, required — Payrails unique identifier of a record.
      - object
        - `fields` string[] — Record field types allowed for display. Possible fields are depended on a record type, e.g. for record type `card` it can be `cardNumber`, `expiryMonth`, `expiryYear`, `securityCode`, `holderName`.
        - `alias` string, required — Alias of a record field.
  - object
    - `type` 'reveal', required — The type of client side elements that you need a configuration for `reveal`. Reveal allows you to securely display record fields stored in Payrails Vault, e.g. card data. This feature is only available by request and requires an approval by Payrails.
    - `auditData` string, required — Data required for an audit trail related to the request to display the fields. E.g. user ID, who requested to display data, reason, etc.
    - `aliases` string[], required — List of record field aliases.
  - object
    - `type` 'reveal', required — The type of client side elements that you need a configuration for `reveal`. Reveal allows you to securely display record fields stored in Payrails Vault, e.g. card data. This feature is only available by request and requires an approval by Payrails.
    - `auditData` string, required — Data required for an audit trail related to the request to display the fields. E.g. user ID, who requested to display data, reason, etc.
    - `instrumentId` string, uuid, required — Unique identifier of an instrument.

## Response `200`

OK. Configurations to initialize Payrails SDK on your client.

- object
  - `version` string, required — The SDK version these configurations are compatible with.
  - `data` string, byte, required — Configurations to initialize the client SDK.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Insufficient Scope.
- `404` — Not Found.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/revisions/9dd2f0158582/schema)