Transactions

Criar transação de assinatura

Cria uma nova transação de assinatura eletrônica. Opcionalmente inclui o documento em base64 no corpo da requisição. Suporta idempotência via header X-Idempotency-Key.

Requer scope transactions:write.

post/v1/transactions

Request

Base URL: https://api.signdocs.com.br
URL: https://api.signdocs.com.br/v1/transactions
Auth: HTTP bearer

Headers

X-Idempotency-Keystring uuid

Chave de idempotência para evitar criação duplicada. Reenviar a mesma chave com o mesmo corpo dentro de 24h devolve a resposta original, sem consumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com um corpo diferente responde 409.

A resposta repetida é a original byte a byte, incluindo os cabeçalhos RateLimit-* — eles refletem a cota no momento da chamada original, já que a repetição não consumiu nada.

Request body

purpose'DOCUMENT_SIGNATURE' | 'ACTION_AUTHENTICATION' required

Finalidade da transação.

documentGroupIdstring

Identificador do grupo de documentos (para assinatura com múltiplos signatários).

signerIndexinteger

Índice do signatário no grupo (inicia em 0).

totalSignersinteger

Total de signatários no grupo (máximo 100).

metadataobject

Metadados customizados (chave-valor string).

expiresInMinutesinteger

Tempo de expiração da transação em minutos.

Example request

{
  "policy": {
    "minSimilarity": 95,
    "minLivenessConfidence": 90
  },
  "signer": {
    "name": "João da Silva",
    "email": "joao@exemplo.com.br",
    "userExternalId": "usr-12345",
    "displayName": "João",
    "cpf": "12345678901",
    "cnpj": "12345678000199",
    "phone": "+5511999998888"
  },
  "document": {
    "filename": "contrato.pdf"
  },
  "action": {
    "type": "PIX_TRANSFER",
    "description": "Transferência PIX de R$ 5.000,00",
    "reference": "ref-abc-123"
  },
  "digitalSignature": {
    "reason": "Assinatura de contrato",
    "location": "São Paulo, SP",
    "contactInfo": "joao@exemplo.com.br"
  },
  "expiresInMinutes": 60
}

Response

Transação criada com sucesso.

transactionIdstring required

Identificador único da transação.

Status possíveis de uma transação.

purpose'DOCUMENT_SIGNATURE' | 'ACTION_AUTHENTICATION' required

Finalidade da transação.

userExternalIdstring required

Identificador externo do usuário.

documentHashstring

Hash SHA-256 do documento (presente se documento foi enviado junto).

createdAtstring date-time required

Data/hora de criação (UTC).

expiresAtstring date-time

Data/hora de expiração (UTC).

Example response

{
  "policy": {
    "minSimilarity": 95,
    "minLivenessConfidence": 90
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.