Individual Results

Get a list of process results

Get a list of process results for a given individual entity

get/v2/individuals/{entityId}/results

Path parameters

entityIdstring required

Unique FrankieOne identifier for an entity

Query parameters

profileNamestring

The unique name of the service profile

createdAtBeforestring date-time

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

createdAtAfterstring date-time

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

updatedAtBeforestring date-time

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

updatedAtAfterstring date-time

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

stepNamesstring[]

List of steps to include, separated by a comma.

stepTypesstring[]

A list of stepTypes the Process Result is associated with

objectTypesstring[]

List of objectTypes to filter upon

classesstring[]

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

systemStatusesstring[]

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

manualStatusesstring[]

List of manualStatus fields to filter results with Available values : UNKNOWN, FALSE_POSITIVE, TRUE_POSITIVE, TRUE_POSITIVE_REJECT, TRUE_POSITIVE_ACCEPT, PASS, FAIL

statesstring[]

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

resultsstring[]

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

sortFieldsstring[]

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

sort'asc' | 'desc'

Order of the sort fields will be sorted upon

pageinteger

The page number that you want to retrieve for the list query

limitinteger

Limit the number of items that will be returned as part of the request

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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-Usernamestring
Example:fred.flintstone@frankieone.com

Username provided by API caller

Response

OK

requestIdstring

The unique request identifier for the API call made.

processResultsProcessResultObject[] — unresolved $ref