KYC API EndpointsDocument

Retrieve Document Verification Check Details.

Get the complete list of all checks that have been performed upon a given document, including the checks that have been performed by others (in those cases you just get the id, status and date run, none of the details).

Authentication

api_keystring
API Key authentication via header

Path parameters

documentIdstringRequiredformat: "uuid"

The documentId returned previously from an earlier call to /check or /entity or /document

Headers

X-Frankie-CustomerIDstringRequiredformat: "uuid"
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-CustomerChildIDstringOptionalformat: "uuid"
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-BackgroundintegerOptional>=0<=1
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. See more details here: https://docs.frankieone.com/docs/asynchronous-calls-backgrounding-processes
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.

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the results of all checks carried out upon this document.
requestIdstringformat: "ulid"

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

checkResultsobject or null
This object holds the identityDocument that was checked and the results associated with said checks. You can also leave the checkResult blank/nil if there are no results for that identityDocument if you wish. This is useful for returning results on a freshly crerated entity where the API user would want to confirm that the data has indeed been stored, and be able to capture relevant documentIds - perhaps to address issues as to why it wasn't checked.

Errors