Table of contents
✅ Check the status of a signature
To check the status of a signature, you must send an HTTP GET request to the endpoint:
1/api/v1/sign/signature-requests/{signature_request_id}
2specifying the signature_request_id and the headers required for authentication.
The returned resource will contain the status property, which can have the following values:
- DRAFT — the signature request has been created, but it has not yet been finalized.
In this case, you need to upload the documents or explicitly mark it as READY. - READY — the signature request has been finalized and will be analyzed and prepared for sending to the citizen.
- WAIT_FOR_SIGNATURE — the signature request has been analyzed and can therefore be sent to the citizen.
This status remains until the citizen completes the signature process. - CANCELLED — the signature request has been cancelled by the organization.
The citizen will no longer be able to proceed with the signature process. - WAIT_FOR_QTSP — the citizen has completed the signature process and the documents are waiting to be signed by the Qualified Trust Service Provider.
- SIGNED — all documents included in the signature request have been signed.
- REJECTED — it was not possible to proceed with signing the documents.
Get the list of created signature requests starting from a dossier
If you do not have a signature_request_id to query the endpoint:
1GET /api/v1/sign/signature-requests/{signature_request_id}
2you can retrieve it starting from the id of the dossier associated with the signature request.
In this case, you must send an HTTP GET request to the endpoint:
1/api/v1/sign/dossiers/{dossier_id}/signature-requests
2to obtain the list of signature requests associated with that dossier.
Once you have obtained the list, you can filter it by:
- signer_id
- created_at
- status
to obtain the signature_request_id needed to retrieve the details of the signature request, as described above.
Ongoing support
For problems or questions after integration, write to us at the address enti-firmaconio@assistenza.pagopa.it