KYC V2 APIIDV

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.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

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

This endpoint expects an object.
applicantIdstringOptional

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

applicationIdstringOptional

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.

countrystringOptional

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.

documentTypestringOptional

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.

referrerstringOptional

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

relayStatestringOptional

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

providerstringOptional

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.

productslist of stringsOptional

What product(s) for the provider to use for the IDV check. If not provided the default product for a provider will be used.

commentobjectOptional

Response

OK

applicantIdstringOptional

The ID of the applicant attached to this check.

countrystringOptional

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

documentTypestringOptional

Document type that will be used for the check.

providerstringOptional

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

smsSentbooleanOptional

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

tokenstringOptional

Tokens are only valid for a limited time.

tokenExpirydatetimeOptional

The time at which the provided token will expire.

vendorParametersmap from strings to stringsOptional

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

requestIdstringOptional

The unique request ID for the API call made.

Errors