AssinAPI

Documentos

Na API, um documento para assinatura é um envelope: um ou mais PDFs, signatários, prazo e ordem.

Criar documento

POST /v1/envelopes cria o envelope em DRAFT. Depois anexe o PDF em POST /v1/envelopes/{id}/documents (multipart file ou JSON contentBase64). O SHA-256 é calculado pela AssinAPI sobre os bytes armazenados.

  • title (obrigatório), message, signatureLevel (ADVANCED padrão | SIMPLE)
  • expirationDays ou expiresAt, signingOrderEnabled, templateId, externalId, metadata

Consultar documento

GET /v1/envelopes/{id} retorna status, documentos (com hashes) e signatários. GET /v1/envelopes lista com filtros status (aceita vários, separados por vírgula), q e paginação por cursor.

Status: DRAFT → SENT → IN_PROGRESS → COMPLETED, ou DECLINED, EXPIRED, CANCELLED.

Enviar documento

POST /v1/envelopes/{id}/send torna o PDF imutável, congela a declaração de consentimento e convida os signatários. Os signingLinks aparecem só nesta resposta — use { "notify": false } para enviar por outro canal.

Cancelar documento

POST /v1/envelopes/{id}/cancel invalida os links. Documentos concluídos não podem ser cancelados.