Skip to content

QES

Let the applicant sign verification documents with a qualified electronic signature (QES).

Two Ukrainian signing methods are available: SmartID of PrivatBank and Diia.Signature in the Diia app.

Before you start

  • QES must be enabled for the form.
  • The verification must have documents to sign.

How it works

  1. You call the Start endpoint of the signing method with the ID of the verification. Our system prepares the documents and returns confirmation_url. This can take up to 60 seconds. If you send a second request while the first one is in progress, our system returns the same confirmation_url.
  2. You show confirmation_url to the applicant. The applicant signs the documents.
  3. You call the Get status endpoint until status is signed. One request can take up to 60 seconds.
  4. Our system saves the signed documents, charges the QES service, and sends the "Signed documents" callback. If the verification is not completed yet, our system sends the callback after the verification is completed.
Operations

SmartID • Start

Request

Use this endpoint to start signing with SmartID of PrivatBank. Our system returns confirmation_url. Show it to the applicant, then call SmartID • Get status to get the result.

Security
API-Key
Bodyapplication/jsonrequired
verification_idstringrequired

ID of the verification with documents to sign

Example:"9a8b7c6d5e4f30211203f4e5d6c7b8a90123"
{
  "verification_id": "9a8b7c6d5e4f30211203f4e5d6c7b8a90123"
}

Responses

OK

The request was processed. Check the status field.

  • need_sign — the link is ready. Show confirmation_url to the applicant.
  • forbidden — the verification has no documents to sign.
  • error — our system could not prepare the link. Try again later.
Bodyapplication/json
statusstring
Enum:"need_sign""forbidden""error"
Example:"need_sign"
dataobject
Response
{
  "status": "need_sign",
  "data": {
    "verification_id": "9a8b7c6d5e4f30211203f4e5d6c7b8a90123",
    "confirmation_url": "https://smartid.example.com/sign/00000000"
  }
}