Sign in
IDV

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

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.

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

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

digitalboolean

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

documentIdstring

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

tokenstring

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

Example request

{
  "fileData": {
    "data": {
      "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
    }
  },
  "token": "41cf9401f0f889616bef"
}

Response

OK

status'AWAITING_OCR_RESULTS_PROVIDER_OFFLINE' | 'AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE' | 'WAITING_DOCUMENT_UPLOAD_FAILED_OCR' | 'AWAITING_DOCUMENT_OCR' | 'DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT' | 'DOCUMENT_INVALID_INCORRECT_FILE_FORMAT' | 'AWAITING_DOCUMENT_UPLOAD_BACK' | 'AWAITING_DOCUMENT_UPLOAD_FRONT' | 'COMPLETE_OCR'

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
requestIdstring

The unique request identifier for the API call made.

ocrResultProcessResultObject — unresolved $ref