Criação do Envelope
O Envelope é o conjunto de documentos e assinantes. É importante entender que assinantes pertencem ao documento e documentos pertencem ao envelope.
POST
https://signhom.acesso.io/api/v1/service/envelope
Headers
Request Body
{
"Success": true,
"Message": "",
"Data": {
"CreatedDate": "14/05/2020 11:55",
"ID_EnvelopeStatus": 1,
"EnvelopeStatus": "Pendente",
"UUID": "x11x111x-x11x-1111-11x1-11x111x1xx1x",
"Documents": [
{
"Url": "https://signhom.acesso.io/api/v1/service/file/y00y000y-y00y-0000-00y0-00y000y0yy00",
"DocumentType": "Nome do Documento",
"CreatedDate": "14/05/2020 11:55",
"EmitterUserName": "Nome do Emissor",
"UUID": "y00y000y-y00y-0000-00y0-00y000y0yy00",
"IsTemplate": false
}
]
}
}
{
"Success": false,
"Message": "Falha ao criar o envelope. O Modelo de Documento enviado não existe",
"Data": ""
}
{
"errors":
[
{"key": "NomeCampo1", "message": "Problema da validação"},
{"key": "NomeCampo2", "message": "Problema da validação"},
]
}
Exemplo de Requisição
{
"EnvelopeFlow": [
{
"ID_Flow": 1
},
{
"ID_Flow": 3
}
],
"IsFrame": "false",
"UrlCallback": "https://callback.com",
"Documents": [
{
"EmitterUserUUID": "",
"EmitterUserName": "Nome do Emissor",
"DocumentType": "Nome do Documento",
"FileBase64": "Base64File",
"UnitUUID": null,
"TemplateUUID": "d610d146-d658-428c-9c63-2067807fb22a",
"TemplateFields": [
{
"FieldCode": "Campo1",
"FieldValue": "teste"
},
{
"FieldCode": "Campo2",
"FieldValue": 0
},
{
"FieldCode": "Campo3",
"FieldValue": NULL
}
],
"Subscribers": [
{
"SubscriberName": "Assinante Um",
"SubscriberCPF": "12345678901",
"SubscriberEmail": "assinante@email.com",
"SubscriberPhone": "5511999999999",
"SubscriberOrder": 1,
"AuthCode": "CódigoDeAcessoWeb"
}
]
}
]
}
Last updated