Skip to content
Last updated

In the eIDAS VideoID workflow, the user completes video identification on a Uanataca VideoID link. The request starts in VIDEOPENDING; when the user finishes the video ID, the status moves to VIDEOREVIEW. An RAO then approves the request (status becomes ENROLLREADY). After that, you upload documents, retrieve the service contract, generate OTP (if using Uanataca SMS), sign, and retrieve signed documents.

Implementing a webhook is recommended so your application is notified when the status changes from VIDEOPENDING to VIDEOREVIEW. See Webhook configuration.

Steps

  1. Create a new VideoID signature request Call Create Videoid (POST /oneshot/api/v1/videoid) with JSON body: mobile_phone_number, email, registration_authority, profile, billing_username, billing_password. Response includes videoid_link, videoid_pk, and request_pk. The request is in VIDEOPENDING status. Redirect the user to videoid_link to complete video identification.

  2. Request approval When video ID is complete, status becomes VIDEOREVIEW. Call Approve Videoid (POST /oneshot/api/v1/videoid/{videoid_pk}/approve) with RAO credentials (username/password/pin and rao) or with token and rao. In 1-step mode, this performs both validation and approval. Status becomes ENROLLREADY. To reject, use Refuse Videoid (see API reference).

  3. Upload documentsUpload Document (POST /oneshot/api/v1/document/{request_pk}) with file=@doc.pdf (or multiple files). Response returns document uids.

  4. Retrieve service contractGet Request Contract (GET /oneshot/api/v1/contract/{request_pk}) (binary PDF).

  5. Generate OTP (Uanataca SMS only)Generate OTP (POST /oneshot/api/v1/otp/{request_pk}).

  6. Sign the documentSign (POST /oneshot/api/v1/sign/{request_pk}) with JSON e.g. {"secret": "123456"} or with ext_unlock_type and ext_unlock_value for other auth.

  7. Retrieve signed documentGet Document (GET /oneshot/api/v1/document/{request_pk}/signed/{document_uid}) (binary PDF).

  8. Delete documents from the OptimizerDelete Document (DELETE /oneshot/api/v1/document/{request_pk}/{document_uid}). Back up files you need before deleting.

If the process fails or is incomplete, the request may move to VIDEOINCOMPLETE or VIDEOERROR. Use Update Request or Get Request if needed.