Transactions

Consultar transação

Retorna os detalhes completos de uma transação, incluindo signatário, etapas e metadados.

Requer scope transactions:read.

get/v1/transactions/{transactionId}

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/transactions/{transactionId}
  • Auth: HTTP bearer

Path parameters

transactionIdstring required

Identificador único da transação.

Response

Detalhes da transação retornados com sucesso.

transactionIdstring required
status'CREATED' | 'DOCUMENT_UPLOADED' | 'IN_PROGRESS' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED' | 'FAILED' required

Status possíveis de uma transação.

purpose'DOCUMENT_SIGNATURE' | 'ACTION_AUTHENTICATION' required

Finalidade da transação.

userExternalIdstring required
documentHashstring
documentGroupIdstring
signerIndexinteger
totalSignersinteger
metadataobject
createdAtstring date-time required
updatedAtstring date-time required
expiresAtstring date-time

Example response

{
  "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"
  },
  "action": {
    "type": "PIX_TRANSFER",
    "description": "Transferência PIX de R$ 5.000,00",
    "reference": "ref-abc-123"
  }
}

Changes

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