Process an identity document photo for ocr
Submit an identity document photo for ocr processing. Results will be in the form of an identity document with kvp's populated with ocr results
Authentication
api_keystring
API Key authentication via header
Headers
X-Frankie-CustomerID
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-CustomerChildID
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-Channel
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
Photo of the identity document to be used, and any known details about the associated document or entity
digital
Is this a digital version of the id, eg Digital Driver Licence screenshot
documentId
document id if known that the scan data should be attached to
entity
fileData
token
if no entity has yet been created for this idv check, pass through the token instead
Response
OK
entity
status
