Skip to content

Diia document sharing

Request

Use this endpoint to get the applicant's documents from the Diia app and start a verification. The applicant does not need to take a photo of a document. Diia sends digital copies of the documents and their data.

By default, our system requests these documents: internal passport (ID card), foreign passport, and taxpayer card.

How it works

  1. You send a request with the ID of a form that has Diia settings and the ID of the applicant.
  2. Our system returns confirmation_url and verification_id. confirmation_url is a deep link to the Diia app.
  3. You show the link to the applicant. The applicant opens it and confirms the sharing in Diia.
  4. Our system updates the applicant profile (name, date of birth, gender, residence country), adds the identity document, the tax ID number document, and the registered address.
  5. Our system creates a verification with the verification types of the form and sends the "Verification completed" callback when the verification is completed.

To check the progress of the sharing on the Diia side, use Diia document sharing status.

Security
API-Key
Bodyapplication/jsonrequired
form_idstringrequired

ID of the form that has Diia settings. Our system uses the verification types, callback URL, and redirect URL of this form

Example:"a1b2c3d4e5f60718293a4b5c6d7e8f901234"
applicant_idstringrequired

ID of an existing applicant

Example:"0f1e2d3c4b5a69788796a5b4c3d2e1f00123"
redirect_urlstring, <= 2048 characters

Optional. URL that Diia opens after the sharing. If you do not send it, our system uses the redirect URL of the form

Example:"https://example.com/diia/done"
{
  "form_id": "a1b2c3d4e5f60718293a4b5c6d7e8f901234",
  "applicant_id": "0f1e2d3c4b5a69788796a5b4c3d2e1f00123",
  "redirect_url": "https://example.com/diia/done"
}

Responses

OK

The request was processed. Check the status field: when our system cannot create a Diia session or a deep link, it returns 200 with status set to error.

Bodyapplication/json
One of:
statusstring
Example:"ok"
dataobject
Response
{
  "status": "ok",
  "data": {
    "applicant_id": "0f1e2d3c4b5a69788796a5b4c3d2e1f00123",
    "verification_id": "9a8b7c6d5e4f30211203f4e5d6c7b8a90123",
    "confirmation_url": "https://diia.example.com/deep-link/00000000"
  }
}