Transactions

Listar transações

Retorna uma lista paginada de transações do tenant autenticado. Suporta filtros por status, usuário, grupo de documentos e intervalo de datas.

Requer scope transactions:read.

get/v1/transactions

Request

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

Query parameters

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

Status possíveis de uma transação.

Filtrar por status da transação.

userExternalIdstring

Filtrar por identificador externo do usuário.

documentGroupIdstring

Filtrar por grupo de documentos.

startDatestring date-time

Data inicial do intervalo (ISO 8601).

endDatestring date-time

Data final do intervalo (ISO 8601).

limitinteger

Número máximo de resultados por página (máximo 100).

nextTokenstring

Token de paginação retornado pela consulta anterior.

Response

Lista de transações retornada com sucesso.

nextTokenstring

Token para buscar a próxima página de resultados.

countinteger required

Número de transações retornadas nesta página.

Example response

{
  "transactions": [
    {
      "policy": {
        "minSimilarity": 95,
        "minLivenessConfidence": 90
      }
    }
  ]
}

Changes

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