KYC API EndpointsEntity

Update Entity and evaluate current results and risk without running any new checks

This does everything an UpdateCheckEntity operation does, except actually verifying anything new. The entity update details are optional so the request body can be empty. If the body is given, then it must contain an EntityCheckDetailsObject like a normal UpdateCheckEntity operation, and the entity in the body must have the same entity ID as in the URL. The result returned is equivalent to the summary result for the UpdateCheckEntity operation.

Path parameters

entityIdstringRequiredformat: "uuid"

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

Headers

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

Query parameters

noInvalidatebooleanOptional
Disable check result invalidation for this update request.
noNotifybooleanOptional
Disable notifications for this request.

Request

The entity details to be updated before evaluating the results
entityobjectRequired
Describes all of the data being used to verify an entity.
deviceCheckDetailsobjectOptional
Contains any/all details we want to pass on to the device checking service as part of an activity / transaction. A transaction isn't just a payment, but can represent a number of different interaction types. See below for more. NOTE: If you're sending this data, then your recipe or requested checkTypes *MUST* include a "device" checkType. Otherwise this data will be ignored and dropped.

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