Skip to main content

Signed Adoption Agreement Query

This endpoint returns the download link for the signed adoption agreement of the auto-signature, with the QI SIGN signature report.

The signed agreement is available once the auto-signature reaches enabled, that is, after all signers complete their signature through the signature links. In any other status, this endpoint responds with ISS0000030.

Temporary link

The signed_url is a temporary link, valid for 24 hours. To get a new link, query the endpoint again.


Signed Agreement Query (GET)​

Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/report
METHOD
GET

Path Params​

FieldTypeDescriptionCharacters
ISSUER-KEYstringUnique issuer key (UUID v4).36

Response​

STATUS
200
Response Body
{
"envelope_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"status": "signed",
"signed_file_url": null,
"documents": [
{
"document_type": "adhesion_auto_signature_term",
"signed_url": "https://qisign-dossiers.s3.amazonaws.com/7bcf5868-784a-4356-85fb-dd72fd53cd4a.pdf?X-Amz-Expires=86400&X-Amz-Signature=...",
"signers": []
}
],
"issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
"issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34"
}

Response Body Params​

FieldTypeDescription
envelope_keystringUnique key of the adoption agreement signature envelope.
statusstringEnvelope status in QI SIGN. Always signed.
signed_file_urlnullNot used for auto-signature. The signed agreement link comes in documents[].signed_url.
documentsarrayEnvelope documents. The adoption agreement is the only document.
issuer_keystringUnique issuer key.
issuer_auto_signature_keystringUnique auto-signature key.

Fields of documents:

FieldTypeDescription
document_typestringAlways adhesion_auto_signature_term.
signed_urlstringTemporary link (24 hours) to download the PDF of the signed agreement, with the signature report.
signersarrayAlways empty in this query. For the signers, use the signature links query.

Errors​

HTTPCodeWhen it occurs
400ISS0000030 (AutoSignatureInWrongStatus)The auto-signature is not in enabled — the adoption agreement has not been signed yet.
403ISS000011 (TenantForbidden)The client does not have full access to the registration of the given issuer.
404ISS000009 (IssuerNotFound)There is no issuer for the given key.
404ISS0000028 (AutoSignatureNotFound)The issuer has no active auto-signature.