Sign in
Individual Results

Approve Manual KYC for an individual

Approve manual KYC (mKYC) for an individual as to allow them to pass all KYC workflow steps without performing eKYC. To ensure there is enough evidence for the mKYC process to be valid, the individual will need to have documents that match at least one of the following combinations:

1 Primary Photographic ID e.g.

  • "DRIVERS_LICENSE": Driver's license.
  • "PASSPORT": Passport

2 Primary Non-Photographic IDs e.g.

  • "BIRTH_CERT": Birth certificate
  • "CITIZENSHIP": Citizenship certificate

1 Primary Non-Photographic ID AND 1 Secondary ID e.g.

  • "VISA": Visa document (not Visa payment card)
  • "IMMIGRATION": Immigration card
  • "NATIONAL_HEALTH_ID": Any national health program ID card (e.g. Medicare, NHS)
  • "NAME_CHANGE": Name change confirmation
  • "MARRIAGE_CERT": Marriage certificate
post/v2/individuals/{entityId}/results/mkyc

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

Request body

approvedBystring required

The person or system who approved the mKYC verification process.

approvedDocumentsstring[] required

The identity documents that were approved as part of the mKYC verification process.

Example request

{
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

requestIdstring

The unique request identifier for the API call made.

processResultsProcessResultObject[] — unresolved $ref