Consultar lista de execuções

Listar execuções de acordo com os filtros.

Requisição

GET

https://api.combateafraude.com/executions?token=<ACCESS_TOKEN>

Header

Identificador	Valor
Content-type	application/json

Query

Identificador	Descrição
token	Token de acesso.
cpf	Filtra pelo CPF presente na execução. Obs: deve conter apenas números.
status	Filtra por status da execução. É possível informar dois ou mais status separando-os com pipe (|), por exemplo: APROVADO|REPROVADO. Consulte Status de uma execução
_reports	Filtra por ID do relatório. É possível informar dois ou mais IDs separando-os com pipe (|), por exemplo: 5f79c07533ab4b4ab675ca34|5f29c07743cc4b4db975cb38.
_limit	Usado para paginação. Limita o número de registros retornados e caso não for informado, o valor padrão é 20. Obs: valor máximo permitido é 20.
_offset	Usado para paginação, em conjunto com _limit. Valor especifica a partir de qual registro será retornado e caso não for informado, o valor padrão é 0.

Os filtros devem ser codificados para formar uma URI válida, substituindo os caracteres inválidos. Existem métodos para essa codificação em diversas linguagens de programação. Em JavaScript é encodeURI.

Exemplo de requisição - cURL

$ curl --location --request GET \
    --url https://api.combateafraude.com/executions?token=<ACCESS_TOKEN>&_limit=20&_offset=0 \
    --header "Content-Type: application/json"

---

Resposta

Os atributos retornados em cada execução podem ser consultados na seção Resposta da página Consultar dados de uma execução. Alguns atributos não são retornados na listagem de execuções, como é o caso de images e em sections, é restringido o retorno apenas para ocr e documentscopy.

Descrição de atributos

Atributo	Tipo	Observação
docs	Array	Lista de execuções
totalItems	Number	Número total de registros encontrados

Exemplo de resposta

{
  "docs": [
    // Execuções
  ],
  "totalItems": 100
}