v1
latestOpenAPI 3.1.02026-07-24560263.9 KBDetalhes do Documento
Visualizar estado atual do Documento
get/envelopes/{envelope_id}/documents/{document_id}
Path parameters
envelope_idstring required
ID do Envelope que possui o documento
document_idstring required
ID do documento
Headers
Authorizationstring required
Access Token gerado pelo gestor da conta
Content-type'application/vnd.api+json'
Content-type padrão para todas requisições JSON:API
Response
200
Example response
{
"data": {
"id": "1108816e-a8da-41ed-b9e9-8d5111eb1f0d",
"type": "envelopes",
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d"
},
"attributes": {
"name": "Envelope de Teste",
"status": "closed",
"deadline_at": "2023-11-11T10:05:35.406-03:00",
"locale": "pt-BR",
"auto_close": true,
"rubric_enabled": true,
"remind_interval": 1,
"default_message": "mensagem customizada",
"created": "2023-09-14T11:22:07.128-03:00",
"modified": "2023-09-14T11:25:33.411-03:00"
},
"relationships": {
"documents": {
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d/relationships/documents",
"related": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d/documents"
}
},
"signers": {
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d/relationships/signers",
"related": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d/signers"
}
},
"requirements": {
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d/relationships/requirements",
"related": "https://sandbox.clicksign.com/api/v3/envelopes/1108816e-a8da-41ed-b9e9-8d5111eb1f0d/requirements"
}
}
}
}
}