IDV API Endpoints

Mark all data from an IDV check as captured

At the end of the IDV data capture process, signal to IDV provider that check is ready to analyse and check. If this call is successful, an entity is created with with any details supplied. This provided entity Id should be used for any subsequent calls

Authentication

api_keystring
API Key authentication via header

Headers

X-Frankie-CustomerIDstringRequired
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-CustomerChildIDstringOptional
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-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

api_keystringOptional

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

X-Frankie-BackgroundintegerOptional
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See out callback API for details on this.\n\nSee more details here:\n https://apidocs.frankiefinancial.com/docs/asynchronous-calls-backgrounding-processes

Request

Details of the applicant's check. If OCR results have already been gathered, then they should be supplied in the entity
checkIdstringOptional
provider CheckID
entityobjectOptional
tokenstringOptional
if no entity has yet been created for this idv check, pass through the token instead

Response

OK
checkStatusstring or null

Can be UNCHECKED, NOT_SUPPORTED, CHECKING, UNPROCESSABLE, NO_MATCH, CHECKED_PARTIAL_SUCCESS, CHECKED_SUCCESS_WITH_NOTES, CHECKED_SUCCESS_CLEAR, CHECKED_FAILED

entityobject or null

Errors