Este endpoint permite conocer todas las ocnfiguraciones del documento, los firmantes y las URL del documento original y firmado.
En lugar de consultar los documentos varias veces al día, te recomendamos usar nuestros . Además de ahorrar recursos en los servidores tanto de ZapSign como de tu sistema, podrás ofrecer retroalimentación en tiempo real a tus usuarios, sin necesidad de esperar N minutos entre cada consulta
Path Parameters
Nombre
Tipo
Descripción
doc_token
string
Document token
Encabezado
Nombre
Tipo
Descripción
Authorization*
string
API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
signed: todos los firmantes firmados el documento.
Posibles estados del firmante:
new: se creo el firmante y éste no abrio el link de firma.
link-opened: el firmante abrió el link de firma y vio el documento.
signed: el firmante firmó el documento.
Request
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", // Use this token if you want to position signatures in the extra document.
"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", // Use this token if you want to position signatures in the extra document.
"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", // Use this token if you want to position signatures in the extra document.
"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": "teste@gmail.com"
},
"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", // draw in screen
"qualification": "",
"require_selfie_photo": false,
"require_document_photo": false,
"geo_latitude": null,
"geo_longitude": null,
"redirect_link": "",
"resend_attempts": {
"whatsapp": 0,
"email": 0,
"sms": 0
},
"send_automatic_whatsapp_signed_file": null
}
]
}
Nota: Si haces una consulta GET sobre un token de un documento extra (es decir, un documento extra en un sobre, no el principal), la respuesta será mucho más corta y contendrá el token del documento principal. Por ejemplo:
Advertencia: los enlaces original_file y signed_file son temporales y caducan en 60 minutos. Si tu sistema necesita guardar esos enlaces, se recomienda almacenarlos en tu propio CDN o llamar al endpoint de cada vez que tu usuario necesite una URL válida que caduque en más de 60 minutos.
