Portal do Desenvolvedor

Assinaturas — assinatura eletrônica de documentos via API

Crie, acompanhe e gerencie processos de assinatura eletrônica de documentos com validade jurídica. Envie documentos para assinatura, cadastre signatários, defina a ordem de assinatura e baixe os documentos assinados.

Todas as requisições usam a URL base https://api.assertivasolucoes.com.br/autentica-assinaturas, com os endpoints sob o caminho /v1, e exigem um token OAuth2 no cabeçalho Authorization: Bearer.

Como o produto funciona

O fluxo de uma assinatura

O processo gira em torno do envelope, que representa uma solicitação de assinatura e reúne um ou mais documentos e signatários. O caminho típico é:

Prepare o documento

Solicite um link temporário de upload e envie o arquivo PDF. O upload retorna uma chave usada na criação do envelope.

Crie o envelope

Envie o documento e os signatários. Defina a forma de envio (e-mail ou SMS) e a ordem de assinatura por prioridade.

Acompanhe e finalize

Consulte o status do envelope, reenvie links quando necessário e, ao finalizar, obtenha os links de download dos documentos assinados.

O que dá para fazer

Documentos e envelopes

Operação	Endpoint	Método
Obter link temporário de upload	`/v1/documentos/obter-link-upload-temporario`	`GET`
Criar envelope	`/v1/envelopes`	`POST`
Consultar envelope	`/v1/envelopes/{envelope}`	`GET`
Filtrar envelopes	`/v1/envelopes/filtrar`	`GET`
Contar envelopes por status	`/v1/envelopes/contador-status`	`GET`
Reenviar links do envelope	`/v1/envelopes/{envelope}/reenviar-link`	`PUT`
Cancelar envelope	`/v1/envelopes/{envelope}/cancelar`	`PUT`
Obter documentos assinados	`/v1/envelopes/{envelope}/links-documentos-assinados`	`GET`
Obter link de um documento	`/v1/envelopes/{envelope}/documentos/{documento}/link-download`	`GET`

Signatários

Operação	Endpoint	Método
Listar perfis de assinatura	`/v1/signatarios/perfis-acesso`	`GET`
Filtrar signatários	`/v1/signatarios`	`GET`
Obter link do signatário	`/v1/signatarios/{signatario}/obter-link`	`GET`
Reenviar link do signatário	`/v1/signatarios/{signatario}/reenviar-link`	`PUT`
Editar signatário	`/v1/signatarios/{signatarioId}`	`PUT`

Relatórios

GET /v1/relatorios/tipos — tipos de relatório disponíveis

GET /v1/relatorios/status — status de processamento

POST /v1/relatorios — cria uma solicitação de relatório (processada em segundo plano)

GET /v1/relatorios/filtrar — lista relatórios de forma paginada

GET /v1/relatorios/{id}/gerar-link — gera link temporário de download (válido por 60 segundos)

Conceitos

Perfis de assinatura

Cada signatário assume um papel no processo, informado no campo perfilAssinatura. Os perfis disponíveis são:

Contrato

contratada, contratante e testemunha.

Execução

exequente e exequido.

Locação

locador, locatario e fiador.

Você também pode consultar os perfis em tempo de execução pelo endpoint GET /v1/signatarios/perfis-acesso, que retorna chave (identificador) e valor (descrição).

Formas de envio e status

O link de assinatura pode ser enviado por email ou sms. Quando a forma de envio for sms, o campo celular passa a ser obrigatório.

Status do envelope	Significado
`emProcesso`	O envelope está aguardando assinaturas.
`finalizado`	Todas as assinaturas foram concluídas.
`expirado`	O prazo de assinatura foi encerrado.
`cancelado`	O envelope foi cancelado.

Conformidade e segurança

Cuidados com dados sensíveis

Nunca exponha o Secret ou o token de acesso no front-end, em repositórios públicos ou em logs. Utilize HTTPS em todas as comunicações e não registre documentos, tokens ou dados pessoais completos.

Valide CPF, CNPJ, e-mail e celular antes do envio.
Não crie envelopes com nomes repetidos.
Não repita o mesmo documento entre signatários do envelope.
Baixe os arquivos imediatamente após obter as URLs temporárias.

Próximos passos

Continue a integração

Autenticação

Gere o token de acesso — pré-requisito de todas as chamadas.

Primeira requisição

Crie seu primeiro envelope, passo a passo.

Casos de uso

Combine as operações em fluxos reais de assinatura.