Skip to main content
POST
/
v2
/
individuals
/
{entityId}
/
actions
/
idv
/
process
At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.
curl --request POST \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/process \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "providerReferenceId": "41cf9401f0f889616bef",
  "token": "41cf9401f0f889616bef",
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL"
  }
}
'
{
  "status": "COMPLETE",
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "workflowExecutionId": "<string>",
  "ocrResult": {
    "processResultId": "<string>",
    "schemaVersion": 123,
    "entityId": "<string>",
    "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
    "stepName": "<string>",
    "stepType": "<string>",
    "objectType": "<string>",
    "objectId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "groupId": "<string>",
    "providerResult": {
      "name": "<string>",
      "source": "<string>",
      "sourceNormalized": "<string>",
      "reference": "<string>",
      "fuzziness": {
        "normalized": 50,
        "actual": "<string>"
      },
      "confidence": {
        "normalized": 50,
        "actual": "<string>"
      },
      "riskScore": 123,
      "errorCode": "<string>",
      "errorMessage": "<string>"
    },
    "result": "MATCH",
    "class": "KYC",
    "supplementaryData": {
      "type": "AML",
      "serviceProvider": "<string>",
      "searchId": "<string>",
      "caseId": "<string>",
      "referenceId": "<string>",
      "originalStepSearchLevel": "<string>",
      "groupingId": "<string>",
      "reportUrl": "<string>",
      "fuzziness": {
        "normalized": 50,
        "actual": "<string>"
      },
      "matchData": {
        "spReferenceId": "<string>",
        "name": "<string>",
        "strength": 123,
        "givenName": "<string>",
        "otherName": "<string>",
        "familyName": "<string>",
        "date": "<string>",
        "address": "<string>",
        "countries": [
          {
            "code": "<string>",
            "matchType": "<string>"
          }
        ],
        "nationalId": {
          "idNumber": "<string>",
          "idType": "<string>",
          "idExpiry": "<string>",
          "issuingCountryCode": "<string>",
          "documentId": "<string>"
        },
        "imageUrl": "<string>",
        "isDeceased": true,
        "isAlias": true,
        "isRelated": true,
        "gender": "MALE"
      },
      "aliases": [
        "<string>"
      ],
      "relatedParties": [
        {
          "name": "<string>",
          "relationship": "<string>"
        }
      ],
      "referenceDocs": [
        {
          "url": "<string>",
          "description": "<string>"
        }
      ],
      "notes": {},
      "pepData": [
        {
          "countryCode": "<string>",
          "countryName": "<string>",
          "sourceName": "<string>",
          "level": "<string>",
          "sourceUrl": "<string>",
          "sourcePosition": "<string>",
          "position": "<string>",
          "positionDescription": "<string>",
          "status": "<string>",
          "listingStart": "<string>",
          "listingEnd": "<string>",
          "imageUrl": "<string>",
          "referenceDocs": [
            {
              "url": "<string>",
              "description": "<string>"
            }
          ],
          "additionalData": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "sanctionData": [
        {
          "countryCode": "<string>",
          "countryName": "<string>",
          "sourceName": "<string>",
          "sourceUrl": "<string>",
          "sourceReason": "<string>",
          "listingStart": "<string>",
          "listingEnd": "<string>",
          "imageUrl": "<string>",
          "referenceDocs": [
            {
              "url": "<string>",
              "description": "<string>"
            }
          ],
          "additionalData": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "watchlistData": [
        {
          "countryCode": "<string>",
          "countryName": "<string>",
          "sourceName": "<string>",
          "sourceUrl": "<string>",
          "sourceReason": "<string>",
          "listingStart": "<string>",
          "listingEnd": "<string>",
          "imageUrl": "<string>",
          "referenceDocs": [
            {
              "url": "<string>",
              "description": "<string>"
            }
          ],
          "additionalData": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "mediaData": [
        {
          "title": "<string>",
          "source": "<string>",
          "snippet": "<string>",
          "sourceDate": "<string>",
          "sourceCountry": "<string>",
          "url": "<string>",
          "isCurrent": true
        }
      ]
    },
    "errors": [
      {
        "code": "<string>",
        "description": "<string>",
        "location": "<string>"
      }
    ],
    "notes": {},
    "systemStatus": "VALID",
    "state": "IN_PROGRESS",
    "riskFactors": [
      {
        "factor": "<string>",
        "value": "<string>"
      }
    ],
    "updatedBy": "<string>"
  }
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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.

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Body

application/json

Init IDV Process Request, used after capture of IDV data from a customer, including photos/videos of the face and ID. For providers that support it, this will synchronously report all report results from the provider. For providers that do not support synchronous reporting, this will request the reports and return a request id and status. The status can be polled for the final result or sent via webhook. Body parameters are optional, if they are not sent, then the latest token for the entity is used.

​
providerReferenceId
string

provider reference Id if known. May be referred to as checkId or interviewId in vendor specific document

Example:

"41cf9401f0f889616bef"

​
token
string

if no check id has yet been created for this idv check, pass through the token instead

Example:

"41cf9401f0f889616bef"

​
comment
object

Response

OK

Init Process Response, used after retrieval of IDV reports from a provider. For providers that support it, this will synchronously report all report results from the provider. For providers that do not support synchronous reporting, this will request the reports and return a request id and status. The status can be polled for the final result or sent via webhook

​
status
enum<string>

Status of the process. Status can be one of:

  • IN_PROGRESS - the provider has been sent the request and is currently still processing the result
  • CHECK_PROCESSING_DOWNLOAD_FAIL - the provider has been sent the request and is currently still processing the result, there was an issue downloading the images that will be retried later automatically
  • WAITING_SELFIE_UPLOAD - the selfie has not been uploaded yet by the applicant, still awaiting applicant action
  • CHECK_PROCESSING - the provider has been sent the request and is currently still processing the result
  • DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT - the document is too large to be processed
  • DOCUMENT_INVALID_INCORRECT_FILE_FORMAT - the document is not a supported file format, mostly only jpeg and png are supported but this is provider specific
  • PROVIDER_OFFLINE - the provider is not available for processing the request
  • COMPLETE - process is valid and completed
Available options:
IN_PROGRESS,
CHECK_PROCESSING_DOWNLOAD_FAIL,
WAITING_SELFIE_UPLOAD,
CHECK_PROCESSING,
DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT,
DOCUMENT_INVALID_INCORRECT_FILE_FORMAT,
PROVIDER_OFFLINE,
COMPLETE
Example:

"COMPLETE"

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
workflowExecutionId
string

If a workflow was run as part of the processing, this is the workflow execution id

​
ocrResult
object