Skip to content

Diia document sharing status

Request

Use this endpoint to check the status of a Diia document sharing request on the Diia side. For example, you can check if the applicant opened the deep link.

Our system keeps the data of a sharing request for 1 hour after you call Diia document sharing. After this time, the endpoint returns 404.

This endpoint shows the status of the request in Diia only. To get the result of the verification, use the "Verification completed" callback.

Security
API-Key
Bodyapplication/jsonrequired
applicant_idstringrequired

ID of the applicant that you sent in the Diia document sharing request

Example:"0f1e2d3c4b5a69788796a5b4c3d2e1f00123"
form_idstringrequired

ID of the form that you sent in the Diia document sharing request

Example:"a1b2c3d4e5f60718293a4b5c6d7e8f901234"
{
  "applicant_id": "0f1e2d3c4b5a69788796a5b4c3d2e1f00123",
  "form_id": "a1b2c3d4e5f60718293a4b5c6d7e8f901234"
}

Responses

OK

The request was successful, and our system returned the status from Diia.

Bodyapplication/json
One of:
statusstring
Example:"ok"
dataobject
Response
{
  "status": "ok",
  "data": {
    "sharing_status": "NOT_USED"
  }
}