Assinatura digital

Envio de contratos para assinatura pela Autentique.

6 rotas. Todas exigem a chave de API no header Authorization, salvo quando marcadas como públicas. Abrir este módulo no Swagger.

Enviar contrato para assinatura

POST /companie/contract/{contractId}/signatures/request

Gera o PDF do contrato, cria o documento na Autentique e envia os convites.

• Debita 1 crédito de assinatura (GET /companie/user/signatureCreditBalance). Sem saldo: 403.
• contract_custom_ids: layouts de contrato que entram no PDF (até 20), na ordem enviada. Sem ele, vale o layout já gravado no contrato ou o layout padrão da empresa. contract_custom_id (um só) ainda é aceito.
• Só pode ser reenviado enquanto o documento não foi assinado (NOT_SIGNED). Cada novo envio cria outro documento e debita outro crédito.
• Exige a Autentique configurada na empresa.
• signature_email_delivery conta os convites por e-mail enviados e os que falharam; os que falharam podem ser reenviados sem novo crédito.

Erros vêm como { "err": "<codigo>" }: missing_digital_signature_credit_exception e error_missing_autentique_token (403), error_document_already_requested_signature_on_autentique (400), error_contract_custom_not_exist e error_contract_not_exist (409). Recusa da Autentique volta 400 com a mensagem em err e o detalhe em error.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
contractId	URL	número	sim

Corpo (application/json)

Campo	Tipo	Obrigatório	Descrição
signers	object[]	sim
signers[].name	string		Nome do signatário.
signers[].email	string		Obrigatório com DELIVERY_METHOD_EMAIL.
signers[].phone	string		Obrigatório com DELIVERY_METHOD_SMS ou DELIVERY_METHOD_WHATSAPP. Formato internacional só com dígitos após o +.
signers[].action	SIGN · APPROVE · RECOGNIZE · SIGN_AS_A_WITNESS · ACKNOWLEDGE_RECEIPT · ENDORSE_IN_BLACK · ENDORSE_IN_WHITE	sim	Papel do signatário. WITNESS também é aceito e vira SIGN_AS_A_WITNESS.
signers[].delivery_method	DELIVERY_METHOD_EMAIL · DELIVERY_METHOD_SMS · DELIVERY_METHOD_WHATSAPP · DELIVERY_METHOD_LINK	sim	Como o convite chega. Com DELIVERY_METHOD_LINK nada é enviado: o link fica em signatures[].link.short_link da consulta.
signers[].security_verifications	object[]		Opcional. [{ "type": "MANUAL" }] pede verificação manual da identidade.
signers[].security_verifications[].type	string
contract_custom_ids	número[]		Ids de layouts de contrato (/companie/contract-custom).
contract_custom_id	número		Layout único. Prefira contract_custom_ids.

Respostas

Status	Descrição
200	Contrato atualizado com o link do documento.
400	Documento já assinado, recusa da Autentique ou parâmetros inválidos.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Sem crédito de assinatura ou Autentique não configurada.
409	Contrato ou layout não encontrado na empresa.
429	Limite de requisições excedido. (ErrorCode)
500	Falha ao gerar o PDF ou erro interno.

Testar no Swagger

Consultar documento de assinatura do contrato

GET /companie/contract/{contractId}/signatures/request

Consulta o documento na Autentique na hora e atualiza autentique_document_status do contrato quando mudou.

• autentiqueDocument.files.original: PDF enviado. files.signed: PDF assinado (só depois de todas as assinaturas). files.certificate: certificado de assinaturas.
• autentiqueDocument.signatures[]: um item por signatário, com public_id, link de assinatura e se já assinou (signed) ou recusou (rejected).

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
contractId	URL	número	sim	Id do contrato.

Respostas

Status	Descrição
200	Documento.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	error_missing_autentique_token: Autentique não configurada.
404	Contrato sem documento de assinatura ou de outra empresa. Corpo: "contract_not_found".
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Reenviar convite de assinatura

POST /companie/contract/{contractId}/signatures/{publicId}/resendSignature

publicId é o public_id do signatário em autentiqueDocument.signatures[] da consulta. Não consome crédito. Registra o reenvio no histórico do contrato. Recusado se o signatário já assinou ou recusou.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
contractId	URL	número	sim	Id do contrato.
publicId	URL	string	sim	public_id do signatário.

Respostas

Status	Descrição
200	Convite reenviado.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	error_missing_autentique_token: Autentique não configurada.
404	error_contract_not_exist ou error_signature_document_not_found. (GenericError)
409	error_signature_invitation_unavailable: signatário não encontrado, já assinou ou recusou. (GenericError)
429	Limite de requisições excedido. (ErrorCode)
502	error_signature_document_unavailable ou error_signature_resend_failed. (GenericError)

Testar no Swagger

Relatório de assinaturas

GET /companie/contract/signatures/report

Contratos da empresa que já foram enviados para assinatura, com uma linha por signatário (cliente e representantes).

• filter usa os valores de período de sempre; com other_period, informe date_start e date_end (YYYY-MM-DD).
• O período filtra pela data de envio (sent_at), que é a data do débito do crédito.
• status filtra pelo status do documento na Autentique (ex.: SIGNED, NOT_SIGNED).
• Sem paginação: devolve todas as linhas do filtro.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
filter	query	all · today · yesterday · this_week · last_week · this_month · last_month · next_month · …		Período. Padrão all.
date_start	query	data		Com other_period.
date_end	query	data		Com other_period.
status	query	string		Status do documento. Ex.: SIGNED.

Respostas

Status	Descrição
200	Linhas do relatório.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Consultar saldo de créditos de assinatura

GET /companie/user/signatureCreditBalance

Cada envio para assinatura consome 1 crédito. Sem saldo, o envio é recusado.

Respostas

Status	Descrição
200	Saldo da empresa.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
404	Empresa não encontrada.
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Listar pacotes de créditos de assinatura ativos

GET /companie/digitalSignatureCredit/active

Pacotes comprados pela empresa com status active, com as cobranças de cada um. Para o saldo disponível, use GET /companie/user/signatureCreditBalance.

Respostas

Status	Descrição
200	Pacotes ativos.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger