Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results.

POST

Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results if successful. Status will be COMPLETE_OCR if OCR was successful and no further images are required. The image can be uploaded or captured via a vendor SDK after calling get IDV token, or can be submitted directly as a fileData.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

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.
digitalbooleanOptional

Is this a digital version of the id, eg Digital Driver Licence screenshot. If not provided assumed to be false.

documentIdstringOptional

document id if known that the scan data should be attached to

fileDataobjectOptional
tokenstringOptional

if the image was captured via a provder SDK, pass through the token instead of the fileData

Response

OK

statusenumOptional

Status of the OCR process. Status can be one of:

  • AWAITING_OCR_RESULTS_PROVIDER_OFFLINE - the provider is offline and the OCR results are not available
  • AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE - the document type is not supported, mostly only passport, driving license and national id are supported but this is provider specific
  • WAITING_DOCUMENT_UPLOAD_FAILED_OCR - the document upload failed to the provider
  • AWAITING_DOCUMENT_OCR - the document is being processed by the provider still and it awaiting results
  • 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
  • AWAITING_DOCUMENT_UPLOAD_BACK - the back of the document needs to be uploaded
  • AWAITING_DOCUMENT_UPLOAD_FRONT - the front of the document needs to be upload
  • COMPLETE_OCR - document OCR is valid and completed
individualobjectOptional
requestIdstringOptional

The unique request ID for the API call made.

ocrResultobjectOptional
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.
Built with