KYC V2 APIIndividual Results

Update the status of a supporting document

Update the status of a support document. This will create or update the process result for the given document. The given document must be a support document with an attachment, otherwise the request will fail with a 400 Bad Request error. Only support documents can currently be reviewed in this way.

Authentication

api_keystring
API Key authentication via header

Path Parameters

entityIdstringRequired
documentIdstringRequired

Headers

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.
manualStatusenumOptional
Any manual status set after the results have been reviewed. - APPROVED: When the document has been reviewed and is acceptable. - REJECTED: When the document has been reviewed and is deemed to be not acceptable. - NEEDS_ATTENTION: When the document has been reviewed and requires further attention.
Allowed values:
commentobjectOptional

Response

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

Errors