Skip to main content
POST
/
v2
/
individuals
/
{entityId}
/
actions
/
idv
/
token
Get an IDV Token for the given individual.
curl --request POST \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "applicantId": "412e8c806fdfb0bb19b5",
  "applicationId": "94d9a75a5072444c",
  "country": "AUS",
  "documentType": "DRIVER_LICENCE",
  "referrer": "https://example.com",
  "relayState": "412e8c806fdfb0bb19b5",
  "provider": "onfido",
  "products": "idv",
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL"
  }
}
'
{
  "applicantId": "<string>",
  "country": "AUS",
  "documentType": "DRIVER_LICENCE",
  "provider": "OCRLabs",
  "smsSent": true,
  "token": "41cf9401f0f889616bef",
  "tokenExpiry": "2020-01-01T00:00:00.000Z",
  "vendorParameters": {
    "tokenURL": "example1.com"
  },
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Body

application/json

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

Example:

"412e8c806fdfb0bb19b5"

​
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.

Example:

"94d9a75a5072444c"

​
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.

Example:

"AUS"

​
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.

Example:

"DRIVER_LICENCE"

​
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

Example:

"https://example.com"

​
relayState
string

State from start of flow that should be relayed through the process via any redirects.

Example:

"412e8c806fdfb0bb19b5"

​
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.

Example:

"onfido"

​
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.

Example:

"idv"

​
comment
object

Response

OK

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.

Example:

"AUS"

​
documentType
string

Document type that will be used for the check.

Example:

"DRIVER_LICENCE"

​
provider
string

Underlying provider, used for selecting the correct SDK if not using SmartUI.

Example:

"OCRLabs"

​
smsSent
boolean

Has a sms to the user already been sent as part of the token request

Example:

true

​
token
string

Tokens are only valid for a limited time.

Example:

"41cf9401f0f889616bef"

​
tokenExpiry
string<date-time>

The time at which the provided token will expire.

Example:

"2020-01-01T00:00:00.000Z"

​
vendorParameters
object

Vendor specific parameters, used for passing through additional parameters from the vendor to instantiate the SDK.

Example:
{ "tokenURL": "example1.com" }
​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"