Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
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.

Get an IDV Token for the given individual.

post/v2/individuals/{entityId}/actions/idv/token

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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.

Request body

applicantIdstring

ID of the applicant/individual in the IDV provider's system. Specify this if resuming/continuing an IDV check

applicationIdstring

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.

countrystring

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.

documentTypestring

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.

referrerstring

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

relayStatestring

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

providerstring

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.

productsstring[]

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 request

{
  "applicantId": "412e8c806fdfb0bb19b5",
  "applicationId": "94d9a75a5072444c",
  "country": "AUS",
  "documentType": "DRIVER_LICENCE",
  "referrer": "https://example.com",
  "relayState": "412e8c806fdfb0bb19b5",
  "provider": "onfido",
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

applicantIdstring

The ID of the applicant attached to this check.

countrystring

Country code to check for. Must be a ISO-3166 alpha-3 code entry.

documentTypestring

Document type that will be used for the check.

providerstring

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

smsSentboolean

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

tokenstring

Tokens are only valid for a limited time.

tokenExpirystring date-time

The time at which the provided token will expire.

vendorParametersobject

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

requestIdstring

The unique request identifier for the API call made.

Example response

{
  "country": "AUS",
  "documentType": "DRIVER_LICENCE",
  "provider": "OCRLabs",
  "smsSent": true,
  "token": "41cf9401f0f889616bef",
  "tokenExpiry": "2020-01-01T00:00:00.000Z",
  "vendorParameters": {
    "tokenURL": "example1.com"
  },
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}