{ "opencollection": "1.0.0", "info": { "name": "Core V2 Audit IDV API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "items": [ { "info": { "name": "IDV", "type": "folder" }, "items": [ { "info": { "name": "Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated, this is to be called before starting the IDV or OCR process.", "type": "http" }, "http": { "method": "POST", "url": "https://api.uat.frankie.one/v2/individuals/:entityId/actions/idv/token", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Unique FrankieOne identifier for an entity" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "Get an IDV Token for the given individual." }, { "info": { "name": "Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results.", "type": "http" }, "http": { "method": "POST", "url": "https://api.uat.frankie.one/v2/individuals/:entityId/actions/idv/ocr", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Unique FrankieOne identifier for an entity" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "https://api.uat.frankie.one/v2/individuals/:entityId/actions/idv/process", "headers": [ { "name": "api_key", "value": "" }, { "name": "X-Frankie-CustomerID", "value": "" }, { "name": "X-Frankie-CustomerChildID", "value": "" }, { "name": "X-Frankie-Channel", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Unique FrankieOne identifier for an entity" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "header" } }, "docs": "At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider\n that check is ready to analyse and check. If this call is successful, an entity\nis populated with with any details supplied if it doesn't not already have a name." } ] } ], "bundled": true }