Get an IDV Token for the given individual.
Unique FrankieOne identifier for an entity
Your Customer ID provided by FrankieOne
Your Customer Child ID provided by FrankieOne
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.
ID of the applicant/individual in the IDV provider’s system. Specify this if resuming/continuing an IDV check
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 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.
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.
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
State from start of flow that should be relayed through the process via any redirects.
OK
The ID of the applicant attached to this check.
Country code to check for. Must be a ISO-3166 alpha-3 code entry.
Document type that will be used for the check.
Underlying provider, used for selecting the correct SDK if not using SmartUI.
Has a sms to the user already been sent as part of the token request
Tokens are only valid for a limited time.
The time at which the provided token will expire.
Vendor specific parameters, used for passing through additional parameters from the vendor to instantiate the SDK.
The unique request ID for the API call made.