Skip to content
Registration Authority
/
/
/
External VideoID
Last updated

External VideoID workflow overview

In External VideoID mode, your platform collects identification evidence and the video; you create a Video ID request and then upload evidences (acceptance, videoid_data: images, ocr_data, security_checks, similarity_level) and the video file via the API. When all evidence and the video are uploaded, the request status becomes VIDEOREVIEW. The RAO then validates or refuses the request; if validated, the RAO approves (generate declaration, contract, approve). Status becomes ENROLLREADY and the user receives the pre-auth link.

Steps

  1. Get first unused scratchcard — Same as classic workflow.

  2. Create request — Create Request with videoid_mode: 1, profile, scratchcard, registration_authority, and user data. Request is in VIDEOPENDING.

  3. Upload data evidence — Upload data evidence (PUT /api/v1/videoid/{video_pk}) with JSON body: acceptance (terms, privacy policy, IP, URL, user-agent, date) and videoid_data (images as base64, ocr_data, security_checks, similarity_level).

  4. Upload video — Upload video (POST /v1/upload/video/{video_identifier}/) with multipart/form-data and video=@file.mp4. When all required evidence and video are uploaded, status becomes VIDEOREVIEW.

  5. Validate or refuse — RAO uses Validate Video ID request or Refuse request to validate or refuse the Video ID.

  6. Approve request — Same as classic/eIDAS: generate RAO declaration, generate contract, Approve request. Status becomes ENROLLREADY.

Data objects

  • acceptance — Client acceptance parameters (customizable).
  • videoid_data.images — document_front, document_rear, document_photo, document_owner (base64).
  • videoid_data.ocr_data — given_name, surname_1, surname_2, mobile_phone_number, email, serial_number, id_document_type, id_document_country.
  • videoid_data.security_checks — otp_validation, documents_match, data_integrity, document_notcopy, document_notexpired, document_notunderage, liveliness.
  • videoid_data.similarity_level — e.g. "high" or 0–100.

See the API reference (OpenAPI) for full request/response schemas.

Previous page
Next page