---
title: "Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated, this is to be called before starting the IDV or OCR process."
method: POST
path: "/v2/individuals/{entityId}/actions/idv/token"
tags: ["IDV"]
---

# Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated, this is to be called before starting the IDV or OCR process.

`POST /v2/individuals/{entityId}/actions/idv/token`

## Request

- Base URL: `https://api.uat.frankie.one`
- URL: `https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token`
- Auth: one of:
  - API key in header `api_key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/frankieone/apis/kyc-v2-api/docs/v2/individuals/:entityId/actions/idv/token/post.ts> (a function with typed inputs; its response is checked against the schema)

Get an IDV Token for the given individual.

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string

## Request body

- IDVTokenRequest: IDV Token Request, queries the IDV provider for a token to be used with their sdk. If there is an existing token for this given entity that isn't expired, that will be returned instead of a new token.
  - `applicantId` string: ID of the applicant/individual in the IDV provider's system. Specify this if resuming/continuing an IDV check
  - `applicationId` string: Reference or name of the application running this IDV check. Specify this if running this check embedded in a application rather than a web page.
  - `country` string: Country code to check for. Must be a ISO-3166 alpha-3 code entry. Only for use with providers that can restrict to a single country.
  - `documentType` string: Document type that will be used for the check. Can be one of DRIVERS_LICENCE, PASSPORT, NATIONAL_ID. . Only for use with providers that can restrict to a single document type.
  - `referrer` string: If this is for a web SDK, then you need to supply the referrer domain so that the token can be validated by the IDV service
  - `relayState` string: State from start of flow that should be relayed through the process via any redirects.
  - `provider` string: What provider to use for the IDV check. This is the name of the provider as configured in the system. If not provided the default provider will be used.
  - `products` string[]: What product(s) for the provider to use for the IDV check. If not provided the default product for a provider will be used.
  - `comment` Comment
    - `commentId` string: Unique identifier for the comment.
    - `text` string: The text content of the comment.

## Response `200`

OK

- IDVTokenResponse: IDV Token Response, contains the token and it's expiry, and any vendor specific parameters.
  - `applicantId` string: The ID of the applicant attached to this check.
  - `country` string: Country code to check for. Must be a ISO-3166 alpha-3 code entry.
  - `documentType` string: Document type that will be used for the check.
  - `provider` string: Underlying provider, used for selecting the correct SDK if not using SmartUI.
  - `smsSent` boolean: Has a sms to the user already been sent as part of the token request
  - `token` string: Tokens are only valid for a limited time.
  - `tokenExpiry` string, date-time: The time at which the provided token will expire.
  - `vendorParameters` object: Vendor specific parameters, used for passing through additional parameters from the vendor to instantiate the SDK.
  - `requestId` string: The unique request identifier for the API call made.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error
- `502`: Bad Gateway
- `503`: Service Unavailable

---

[API](https://skmtc.dev/frankieone/apis/kyc-v2-api.md) - [All operations](https://skmtc.dev/frankieone/apis/kyc-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frankieone/apis/kyc-v2-api/revisions/880b27506cbb?raw)