---
title: "Initiate a new Identity Video Verification"
method: POST
path: "/verifications/identity_videos"
tags: ["Identity Video Verification"]
---

# Initiate a new Identity Video Verification

`POST /verifications/identity_videos`

Request verification of a person's identity by recording their documents and/or themselves.

## Request body

- InitiateIdentityVideo
  - `first_name` string, required
  - `last_name` string, required
  - `redirection_url` string, uri, required — The URL to redirect the person back to your application or website after the identity verification flow is complete.
  - `face_recognition` boolean — Enable face recognition step in the identity verification flow.
  - `pvid` boolean — Enable PVID mode in the identity verification flow.
  - `workspace_id` string, uuid, nullable — Scopes the verification to a specific workspace. Defaults to the default workspace if not specified.
  - `workflow_session_id` string, uuid, nullable — Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.
  - `previous_attempt_id` string, uuid, nullable — ID of the previous attempt within the same `workflow_session_id`. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.
  - `min_age` integer, nullable — Minimum age required for the document holder.
  - `max_age` integer, nullable — Maximum age allowed for the document holder.
  - `prohibited_countries` string[], nullable — List of prohibited issuing countries (ISO 3166-1 alpha-2).
  - `pre_selected_residence_country_code` string, ISO 3166-1 alpha-2, nullable — Pre-fill the residence country in the verification flow (ISO 3166-1 alpha-2, uppercase).
  - `pre_selected_document_issuing_country_code` string, ISO 3166-1 alpha-2, nullable — Pre-fill the document issuing country in the verification flow (ISO 3166-1 alpha-2, uppercase).
  - `pre_selected_document_type` 'id_card' | 'passport' | 'residence_permit' | 'driver_license' | 'travel_document', nullable — Pre-fill the document type in the verification flow.
  - `pre_selected_locale` string, ISO 639-1, nullable — Pre-fill the UI language of the verification flow (ISO 639-1, lowercase 2-letter code).

## Response `201`

Created

- IdentityVideoFull
  - `id` string, uuid, required — The unique identifier for a resource.
  - `workspace_id` string, uuid, required — The Workspace ID in which the verification has been created.
  - `created_at` string, date-time, required — Creation date of the Identity Video Verification.
  - `updated_at` string, date-time, required — Update date of the Identity Video Verification.
  - `status` 'pending' | 'verified' | 'failed' | 'inconclusive', required — Status of the Identity Video Verification
  - `status_codes` string[], required — List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.
  - `data_anonymized` boolean, required — Indicates if the personal data extracted has been anonymized. If set to `true`, the personal data has been anonymized and most fields will be NULL.
  - `face_recognition` boolean, required — Indicates if face recognition was enabled during the verification process.
  - `pvid` boolean, required — Indicates if PVID was enabled during the verification process.
  - `workflow_session_id` string, uuid, nullable, required — Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.
  - `previous_attempt_id` string, uuid, nullable, required — ID of the previous attempt within the same `workflow_session_id`. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.
  - `verification_url` string, uri, nullable, required — The URL of the verification page that the user used to begin the verification process.
  - `data` IdentityVideoFullAllOfData, required
    - `extracted_from_document` IdentityVideoDocument, nullable, required — Includes all information that has been extracted from the document, as well as the best images of the document.
      - `full_name` string, nullable, required — Full name of the document holder as it appears on the identity document
      - `born_on` string, date, nullable, required — Date of birth on the document
      - `type` 'null' | 'driver_license' | 'id_card' | 'passport' | 'residence_permit' | 'travel_document', nullable, required — Type of document.
      - `issuing_country_code` string, ISO 3166-1 alpha-2, nullable, required
      - `national_identification_number` string, nullable, required — Some documents may contain a national identification number. For example, Italian ID cards contain the Codice Fiscale on the back of the document. When this data is available on the document, it will be returned here, otherwise it will be NULL. Consult our [guide](https://developers.youtrust.com/docs/video-based-identity-verification) for more details and examples.
    - `evidence` IdentityVideoFullAllOfDataEvidence, required — Documentary evidence captured during the verification process
      - `document_front_image_url` string, uri, nullable, required — Temporary public link to the front image. Available for 10 minutes after the user completed the verification.
      - `document_back_image_url` string, uri, nullable, required — Temporary public link to the back image. Available for 10 minutes after the user completed the verification.
      - `face_image_url` string, uri, nullable, required — Temporary public link to the face image. Available for 10 minutes after the user completed the verification.

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `404` — Resource not found
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)