IDV API Endpoints

Retrieve a token to use with a check

Queries the IDV provider for a token to be used with their sdk

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time
X-Frankie-CustomerChildIDstringOptional
If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children
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

Details required to fetch a token from the IDV provider
applicantIdstringOptional

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

applicationIdstringOptional

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

consentbooleanOptional
Has user consented. If not supplied or is false, consent will need to be submitted via provider SDK
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. Can be one of DRIVERS_LICENCE, PASSPORT, NATIONAL_ID

entityobjectOptional
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

Response

OK
applicantIdstring or null
The ID of the applicant attached to this check
countrystring or null

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

documentTypestring or null
Document type that will be used for the check
entityobject or null
providerstring or null
Underlying provider, used for selecting the correct SDK if not using SmartUI
sms_sentboolean or null
Has a sms to the user already been sent as part of the token request
tokenstring or null
Tokens are only valid for a limited time
tokenExpirystring or null
The time at which the provided token will expire
vendorParametersmap from strings to strings or null

Errors