KYC V2 APISearch

Search for individual profiles

Search for Individuals that match the provided search parameters. Search parameters are supplied in the form of an entity object, similar to how you would create an individual.

Headers

api_keystringRequired
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

sortFieldsstringOptional

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

Request

This endpoint expects an object.
searchobjectOptional
filtersobjectOptional

Response

OK
metaobject or null
Meta information about the request and response that will be returned during a list operation
requestIdstring or null
The unique request ID for the API call made.
matcheslist of lists of objects or null

Errors