Sign in
latestOpenAPI 3.0.32026-07-2141248520.9 KB

880b27506cbb

IDV

At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.

At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check. If this call is successful, an entity is populated with with any details supplied if it doesn't not already have a name.

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

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

providerReferenceIdstring

provider reference Id if known. May be referred to as checkId or interviewId in vendor specific document

tokenstring

if no check id has yet been created for this idv check, pass through the token instead

Example request

{
  "providerReferenceId": "41cf9401f0f889616bef",
  "token": "41cf9401f0f889616bef",
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

status'IN_PROGRESS' | 'CHECK_PROCESSING_DOWNLOAD_FAIL' | 'WAITING_SELFIE_UPLOAD' | 'CHECK_PROCESSING' | 'DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT' | 'DOCUMENT_INVALID_INCORRECT_FILE_FORMAT' | 'PROVIDER_OFFLINE' | 'COMPLETE'

Status of the process. Status can be one of:

  • IN_PROGRESS - the provider has been sent the request and is currently still processing the result
  • CHECK_PROCESSING_DOWNLOAD_FAIL - the provider has been sent the request and is currently still processing the result, there was an issue downloading the images that will be retried later automatically
  • WAITING_SELFIE_UPLOAD - the selfie has not been uploaded yet by the applicant, still awaiting applicant action
  • CHECK_PROCESSING - the provider has been sent the request and is currently still processing the result
  • DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT - the document is too large to be processed
  • DOCUMENT_INVALID_INCORRECT_FILE_FORMAT - the document is not a supported file format, mostly only jpeg and png are supported but this is provider specific
  • PROVIDER_OFFLINE - the provider is not available for processing the request
  • COMPLETE - process is valid and completed
requestIdstring

The unique request identifier for the API call made.

workflowExecutionIdstring

If a workflow was run as part of the processing, this is the workflow execution id

ocrResultProcessResultObject — unresolved $ref