IDV API Endpoints

Process results of IDV check. Optionally re-process results

After check has been processed, download all reports from provider and process them into a result

Headers

api_keystringRequired
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

Request

This endpoint expects an object.
checkIdstringOptional
provider CheckID
entityobjectOptional
providerstringOptional
Underlying provider, used for selecting the correct SDK
reprocessResultbooleanOptional

if set to true, will re-process completed results

tokenstringOptional
if no entity has yet been created for this idv check, pass through the token instead

Response

OK
checkStatusstringOptional

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

entityobjectOptional

Errors