KYC API EndpointsEntity

Retrieve Entity Verification Check Details

Get the complete list of all checks that have been performed upon a given entity and its documents, 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

entityIdstringRequiredformat: "uuid"

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

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-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.

Query parameters

alldatabooleanOptional
Requests that all check data (including historic) should be included in the response to a "get checks" request. This is as opposed to a filtered view where expired results are by default not included for entities that have an assigned profile. Note: When allData is set to true the risk and summary data of the entity are excluded as this information does not make sense in the context of a response that can include overridden and ignored check data.
awaitResultstringOptional

Poll for the given result type until a result is found (whether pass or fail) or the timeout (see below) is reached. If timeout is reached, a 404 will be returned.

timeoutintegerOptional
Timeout in seconds to poll for a result. Ignored if awaitResult parameter is not supplied. Defaults to 30 seconds if not supplied. Minimum of 1 second and maximum of 60 seconds is allowed.

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 entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.

blacklistCheckResultslist of objects or null

Collection of check results for the entity having been previously blacklisted.

An array of matched blacklisted entities sorted by match confidence level (highest first).

checkResultsListSummarieslist of objects or null

Contains a list of all checkSummary records (one for each check)

checkRiskobject or null

Stores the generic results of a process (check, scan, compare, verify, etc)

checkSummaryobject or null

Stores the generic results of a process (check, scan, compare, verify, etc)

duplicateCheckResultslist of objects or null

Collection of check results for the entity having previously been checked.

An array of matched checked entities sorted by match confidence level (highest first).

entityobject or null
Describes all of the data being used to verify an entity.
entityProfileResultobject or null
Contains the results of a check against an entity profile. The entityProfileResult will be returned instead of a checkSummary to provide the full details of the verification process.
entityResultobject or null
This will hold all of the check results that were performed against the
fraudCheckResultsobject or null

Collection of fraud check results for the entity.

Contains fraud list and/or background result arrays. Other fraud check types will appear over time

manualCheckResultslist of objects or null
Collection of check results for the manual KYC. An array of one entry with the manual check result.
requestIdstring or nullformat: "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.

sharedBlocklistCheckResultslist of objects or null

Collection of check results for the entity having been previously blacklisted in shared blocklist.

An array of matched blacklisted entities sorted by match confidence level (highest first).

Errors