KYC V2 APIIndividual Results

Update the status of IDV process results

Update the status of a set of IDV process results.

Path parameters

entityIdstringRequired

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

Request

This endpoint expects an object.
processResultslist of stringsOptional
manualStatusenumOptional

Any manual status set after the results have been reviewed.

  • CLEAR: When the result is determined to be clear and no further action is needed.
  • REJECTED: When the result is determined to be rejected and no further action is needed.
Allowed values:
commentobjectOptional

Response

OK
requestIdstring or null
The unique request identifier for the API call made.
processResultslist of objects or null

Errors