link-opened (abriu o link do documento pelo menos uma vez)
signed (assinou o documento)
Dica: em vez de consultar os documentos várias vezes ao dia, utilize nossos webhooks. Além de ser uma economia da capacidade computacional dos nossos e seus servidores, você também conseguirá dar um feedback em tempo real ao seu usuário, e não a cada N minutos.
Exemplo de resposta
Atenção: os links retornados em original_file e signed_file são temporários e duram 60 minutos. Caso seu sistema necessite salvar estes links é recomendado que sejam baixados em uma CDN própria ou que este endpoint seja consultado sempre para garantir que seu usuário sempre receberá um link válido.
{"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":"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","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, } ],"answers": [ // lista de variaveis e respostas no modelo dinamico (caso o documento tenha sido criado através de um modelo dinamico) {"variable":"NOME COMPLETO","value":"Nome Teste" }, {"variable":"NÚMERO DO CPF","value":"99999999999" }, {"variable":"ENDEREÇO COMPLETO","value":"Endereço teste" } ]}
Obs: caso você faça um GET em um token de um extra_doc (documento extra, não o documento principal), a resposta será muito mais curta e conterá o token do documento principal, por exemplo:
{"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"}