ZapSign API
Search…
Detail document
get
https://api.zapsign.com.br
/api/v1/docs/{{doc_token}}/?api_token={{access_token}}
Detail document
The possible statuses for a document are:
  • pending
  • signed (all signatories signed the document)
The possible statuses of a signer are:
  • new (signer has been created)
  • link-opened (opened document link at least once)
  • signed (signed the document)
Tip: instead of consulting documents several times a day, use our webhooks. In addition to saving the computing power of our and your servers, you'll also be able to give feedback in real time to your user, not every N minutes.

Response

{
"sandbox": false,
"external_id": "",
"open_id": 16,
"token": "965ea3fa-938a-4b7d-84ed-7d7598b17231",
"name": "sample.pdf",
"folder_path": "/",
"status": "pending",
"lang": "pt-br",
"original_file": "https://zapsign.s3.amazonaws.com/aaa/aaa5e7a6-56dd-4ad9-9a1c-6e7022fbfafa/658bee7b-1dd7-442c-b426-4f111aaedffb.pdf",
"signed_file": null,
"extra_docs": [
{
"open_id": 17,
"token": "50c7d90e-ead6-46b5-99d6-33d2d3b9a31f", //utilize esse token caso queira posicionar assinaturas no documento extra
"name": "doc extra1.pdf",
"original_file": "https://zapsign.s3.amazonaws.com/aaa/48025712-b429-4216-8a33-d90c575d0b7f/0e2d0a87-a0f6-4a49-a05f-7a439fd7308e.pdf",
"signed_file": null
},
{
"open_id": 18,
"token": "c8f2a1c4-58f2-4240-bcf5-f1dc34b07a7c", //utilize esse token caso queira posicionar assinaturas no documento extra
"name": "doc extra2.pdf",
"original_file": "https://zapsign.s3.amazonaws.com/aaa/52d81e46-64ea-4a2d-9171-c5c8907d895c/9b1353c8-73cd-4cca-a342-ba1e7f0354a9.pdf",
"signed_file": null
},
{
"open_id": 19,
"token": "733b7538-cd38-41c1-abe7-07d06e4f6b8d", //utilize esse token caso queira posicionar assinaturas no documento extra
"name": "doc extra3.pdf",
"original_file": "https://zapsign.s3.amazonaws.com/dev/2021/8/api/57a8bb75-641f-4cf6-962c-587774188dce.pdf",
"signed_file": null
}
],
"created_through": "api",
"deleted": false,
"deleted_at": null,
"signed_file_only_finished": false,
"disable_signer_emails": false,
"brand_logo": "",
"brand_primary_color": "",
"created_at": "2021-08-23T22:04:06.650460Z",
"last_update_at": "2021-08-23T22:44:06.901255Z",
"created_by": {
"email": "[email protected]"
},
"signers": [
{
"external_id": "",
"token": "ca63b929-c053-4f7b-8680-8f0380ca4a57",
"status": "new",
"name": "João da Silva",
"lock_name": false,
"email": "",
"lock_email": false,
"phone_country": "55",
"phone_number": "",
"lock_phone": false,
"times_viewed": 0,
"last_view_at": null,
"signed_at": null,
"auth_mode": "assinaturaTela",
"qualification": "",
"require_selfie_photo": false,
"require_document_photo": false,
"geo_latitude": null,
"geo_longitude": null,
"redirect_link": ""
}
]
}
Note: if you do a GET on an extra_doc token (extra document, not the main document), the response will be much shorter and will contain the main document token, for example:
{
"open_id": 22,
"token": "a35c3333-5c6e-4dbf-99cc-fc6345f91d8c",
"name": "doc extra 1.pdf",
"original_file": "https://zapsign.s3.amazonaws.com/aaa/f42c4315-ccf9-48c9-97df-ddd14ec5b865/e3a670c8-c811-45ef-a392-08b68db49a41.pdf",
"signed_file": null,
"parent_doc_token": "965ea3fa-938a-4b7d-84ed-7d7598b17231"
}