---
title: "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."
method: POST
path: "/v2/individuals/{entityId}/actions/idv/process"
tags: ["IDV"]
---

# 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.

`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. If this call is successful, an entity
is populated with with any details supplied if it doesn't not already have a name.

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string

## Request body

- IDVInitProcessRequest — 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
  - `token` string — if no check id has yet been created for this idv check, pass through the token instead
  - `comment` Comment
    - `commentId` string — Unique identifier for the comment.
    - `text` string — The text content of the comment.

## Response `200`

OK

- IDVInitProcessResponse — 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` 'IN_PROGRESS' | 'CHECK_PROCESSING_DOWNLOAD_FAIL' | 'WAITING_SELFIE_UPLOAD' | 'CHECK_PROCESSING' | 'DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT' | 'DOCUMENT_INVALID_INCORRECT_FILE_FORMAT' | 'PROVIDER_OFFLINE' | 'COMPLETE' — 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
  - `requestId` string — The unique request identifier for the API call made.
  - `workflowExecutionId` string — If a workflow was run as part of the processing, this is the workflow execution id
  - `ocrResult` ProcessResultObject — unresolved $ref

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/frankieone/apis/kyc-v2-api.md) · [All operations](https://skmtc.net/frankieone/apis/kyc-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frankieone/kyc-v2-api/revisions/880b27506cbb/schema)