KYC V2 APIIndividual Results

Get a list of process results

Get a list of process results for a given individual entity

Path parameters

entityIdstringRequired
Unique FrankieOne identifier for an entity

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
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.

X-Frankie-UsernamestringOptional
Username provided by API caller

Query parameters

profileNamestringOptional
The unique name of the service profile
createdAtBeforestringOptionalformat: "date-time"

Filter on the createdAt field, results returned are based on being before the value (inclusively)

createdAtAfterstringOptionalformat: "date-time"

Filter on the createdAt field, results returned are based on being after the value (inclusively)

updatedAtBeforestringOptionalformat: "date-time"

Filter on the updatedAt field, results returned are based on being before the value (inclusively)

updatedAtAfterstringOptionalformat: "date-time"

Filter on the updatedAt field, results returned are based on being before the value (inclusively)

stepNameslist of stringsOptional
List of steps to include, separated by a comma.
stepTypeslist of stringsOptional
A list of stepTypes the Process Result is associated with
objectTypeslist of stringsOptional
List of objectTypes to filter upon
classeslist of stringsOptional

List of classes to filter results with Available values : KYC, ID, IDV, AML, FRAUDLIST, FRAUDCHECK, DEVICE, MOBILE, EMAIL, LOOKUP, CREATE, UPDATE, DELETE, MANUAL, ORGANIZATION_PROFILE, ORGANIZATION_OWNERSHIP

systemStatuseslist of stringsOptional

List of systemStatus values to filter results with Available values : VALID, EXPIRED, STALE, MARKED_INVALID, MARKED_IGNORE

manualStatuseslist of stringsOptional
stateslist of stringsOptional

List of state values to filter results with Available values : IN_PROGRESS, COMPLETED, TIMEOUT, ERROR

resultslist of stringsOptional

List of result value that the Process Result will be filtered with Available values : MATCH, PARTIAL_MATCH, INVALID_MATCH, NO_MATCH, CLEAR, HIT, BAD_DATA, CREATED, UPDATED, DELETED, FAIL

sortFieldslist of stringsOptional

List of fields that the Process Results will be filtered with Available values : createdAt, updatedAt

sortenumOptional
Order of the sort fields will be sorted upon
Allowed values:
pageintegerOptional
The page number that you want to retrieve for the list query
limitintegerOptional>=1Defaults to 20
Limit the number of items that will be returned as part of the request

Response

OK
metaobject or null
Meta information about the request and response returned during a list operation.
requestIdstring or null
The unique request identifier for the API call made.
processResultslist of objects or null

Errors