Internal only
Add a special internal ‘entity result’ to superceed any previous real checks until the next one.
The entityId returned previously from an earlier call to /check or /entity
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.
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.
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:
Any alphanumeric string is supported though. Anything over 64 characters will be truncated.
The status of an entity. Valid values are:
The risk override setting for an entity. This value will be used until a verify result updates a real risk factor. Valid values are:
A comment describing the reason for a request.
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.
Collection of check results for the entity having been previously blacklisted.
An array of matched blacklisted entities sorted by match confidence level (highest first).
Contains a list of all checkSummary records (one for each check)
Stores the generic results of a process (check, scan, compare, verify, etc)
Stores the generic results of a process (check, scan, compare, verify, etc)
Collection of check results for the entity having previously been checked.
An array of matched checked entities sorted by match confidence level (highest first).
Describes all of the data being used to verify an entity.
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.
This will hold all of the check results that were performed against the
Collection of fraud check results for the entity.
Contains fraud list and/or background result arrays. Other fraud check types will appear over time
Collection of check results for the manual KYC.
An array of one entry with the manual check result.
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.