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

Name	Type	Description
Authorization*	string	Token de acesso adquirido pela plataforma Identity (bearer)

Request Body

Name	Type	Description
FieldValue	string	Valor do campo que deseja ser preenchido; Para valores booleanos utilize 0 ou 1; Para enviar o campo vazio utilize NULL;
FieldCode	string	Código do campo de modelo, encontrado dentro do Dashboard ao configurar um modelo.
TemplateFields	array	Caso seja necessário, ao enviar um documento com modelo é possível preencher alguns campos previamente.
UrlCallback	string	Caso seja necessário WebHook para confirmação é chamado após conclusão de processamento de assinaturas do envelope.
SubscriberOrder	integer	Ordem do assinante no envelope
AuthCode	string	Código de acesso web, utilizado para abrir o envelope no momento da assinatura. (Obrigatório quando utilizar EnvelopeFlow: 1)
SubscriberPhone*	string	Celular do assinante. Necessário informar o código do país sem a adição do caractere especial "+" Ex: (55 + DDD + Número ) (Obrigatório se não houver e-mail)
SubscriberEmail*	string	E-mail do assinante. (Obrigatório se não houver telefone)
SubscriberCPF*	string	CPF do assinante, somente numeros.
SubscriberName*	string	Nome do assinante (não aceita números)
Subscribers*	array	Assinantes que fazem parte do documento
UnitUUID	string	UUID da unidade/filial
TemplateUUID	string	UUID do modelo. Deixe em branco o FileBase64 caso deseje manter o arquivo original, preencha-o caso deseje alterar
FileBase64*	string	arquivo PDF no formato BASE64
EmitterUserEmail*	string	E-mail do emissor do documento
EmitterUserName*	string	Nome do emissor do documento
EmitterUserUUID *	string	UUID contido no Token de PJ da Acesso Digital
Documents*	array	Documentos que fazem parte do envelope
IsFrame	boolean	Se deve exibir a URL com o link assinatura no retorno (Campo: URLFrameFull)
EnvelopeFlow*	array	Modo de Autenticação: 1 - Código 2 - Biometria 3 - Desenho da Assinatura
DocumentType*	string	Nome do documento

200 Documento criado com sucesso.

{
    "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
            }
        ]
    }
}

401 O Token está expirado ou sem permissão.

500 Quando algo estiver incorreto, o detalhe do problema será retornado no campo Message.

{
    "Success": false,
    "Message": "Falha ao criar o envelope. O Modelo de Documento enviado não existe",
    "Data": ""
}

400: Bad Request Quando alguma propriedade estiver incorreta, onde será retornado um json contendo o campo e o erro de validação.

{
	"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": "[e-mail]",
                    "SubscriberPhone": "5511999999999",
                    "SubscriberOrder": 1,
                    "AuthCode": "CódigoDeAcessoWeb"
                }
            ]
        }
    ]
}