Consultar dados de uma execução · Combate à Fraude Docs

Listar detalhes de uma execução.

Requisição

GET

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

Header

Identificador	Valor
Content-type	`application/json`

Path

Identificador	Tipo	Descrição
`REPORT_ID`	String	Identificador do relatório
`EXECUTION_ID`	String	Identificador da execução

Query

Identificador	Descrição
`ACCESS_TOKEN`	Token de acesso
p_<CUSTOM_DATA_KEY>¹	Metadados

[¹]: na busca pelo atributo personalizado customId, deverá chamar-se p_customId.

Exemplo de requisição - cURL

$ curl --location --request GET \
    --url https://api.combateafraude.com/reports/<REPORT_ID>/executions/<EXECUTION_ID>?token=<ACCESS_TOKEN> \
    --header "Content-Type: application/json"

Resposta

Os atributos, exceto os contidos em sections e documentscopyRequestDate, são comuns às execuções. Veja a seção atributos por relatório para consultar os atributos específicos de cada relatório.

Note que nem sempre todos os atributos documentados serão retornados. A resposta pode variar de acordo com as definições do relatório (fluxo de processamento do documento), afetando principalmente os dados contidos em sections.

Descrição de atributos comuns

Atributo	Tipo	Observação
_id	String	Identificador da execução
report	String	Identificador do relatório
status	String	Consulte Status de uma execução
sections	Object	Consulte Seções específicas por relatório
fraud	Boolean	Indicação de fraude
createdAt	String	Data de criação da execução
images.back	String	Nome da imagem da frente do documento
images.front	String	Nome da imagem de verso do documento
images.selfie	String	Nome da imagem de selfie
type	String	Tipo do documento (`rg`, `cnh`, `rne`, `outros` ou `invalido`)
updatedAt	String	Data da última atualização no registro da execução
validations	Array	Validações das regras configuradas no relatório
validations.rule	String	Nome da regra
validations.title	String	Título da regra
validations.description	String	Descrição da regra
validations.status	String	Status da regra
parameters	Object	Atributos opcionais enviados na execução
data	Object	Objeto contendo os dados validados nas bases oficiais. Uma vez disposto dentro de `data`, tem-se que o valor do atributo é válido frente as bases oficiais consultadas
data.name	String	Nome
data.cpf	String	CPF
data.birthDate	String	Data de nascimento
data.motherName	String	Nome da mãe
data.fatherName	String	Nome do pai
documentscopyRequestDate	String	Data em que o documento foi enviado para a documentoscopia
reprovalReasons¹	Array	Array de strings contendo os motivos de reprovação quando realizada de forma manual.
files	Array	Arquivos auxiliares enviados na execução
files.url	String	Link para o documento
files.type	String	Tipo do documento

[¹]: uma execução pode ser reprovada manualmente pelo Time de Suporte da Combateafraude.com ou pelo próprio usuário, quando o status estiver como Pendente.

Exemplo de resposta

{
  "_id": "xxxxxxxxxxxxxxxxx",
  "report": "xxxxxxxxxxxxxxxxx",
  "status": "APROVADO",
  "sections": {},
  "createdAt": "2019-08-01T18:01:38.413Z",
  "images": {
    "back": "xxxxxxxxxxxxxxxxx_cnh_back.jpeg",
    "selfie": "xxxxxxxxxxxxxxxxx_cnh_selfie.jpeg",
    "front": "xxxxxxxxxxxxxxxxx_cnh_front.jpeg"
  },
  "type": "cnh",
  "updatedAt": "2019-08-01T18:02:16.733Z",
  "validations": [{
    "rule": "identificador",
    "title": "...",
    "description": "...",
    "status": "VALID"
  }],
  "parameters": {
    "cpf": "00000000000"
  },
  "files": [
    {
      "url": "https://url_document.com",
      "type": "Document type"
    }
  ]
}

Sobre o Ambiente de Homologação (Beta)

A CAF possui a opção de se usar um ambiente de homologação para validar os envios e retornos da API. Nosso ambiente Beta é uma cópia fiel de todo o ambiente de produção, com as duas únicas diferenças de simular o retorno da seção officialData (consulte Seções Combate à Fraude para mais detalhes sobre essa seção) e de não possuir monitoramento ativo nas execuções enviadas (isto é, se algum documento desse ambiente cair para análise manual tanto do suporte quanto da documentoscopia, irá ficar "preso" nesse status). Podemos alterar dados e status das execuções enviadas livremente, com o intuito de validar a resposta da API tanto no endpoint de envio de documentos, quanto no endpoint de consulta da execução.

Para iniciar o processo de usar o ambiente Beta, segue o mesmo fluxo para configurar uma conta em produção. Nosso time irá criar a conta e passar as credenciais para vocês, que poderão usá-las para logar em https://app.beta.combateafraude.com.br e obterem o token de acesso e os identificadores de relatórios (reportId) do ambiente.

Nota: apesar da seção officialData ter seu resultado simulado, o resto da requisição segue as regras idênticas ao ambiente de produção. Por exemplo, se um CPF for enviado no parâmetro e for divergente do documento, vai manter a execução em processando até que seja avaliada manualmente e reprovada.

Requisição

GET

https://api.beta.combateafraude.com/reports/<REPORT_ID>/executions/<EXECUTION_ID>?token=<ACCESS_TOKEN>

Todos os atributos acima citados para o body da requisição e os exemplos de resposta se mantém os mesmos, assim como a estrutura da API, tanto para produção quanto para beta. Todas as seções das fontes personalizadas configuradas em beta também possuirão o formato idêntico à produção.

Produto Combate a Fraude: Seções Combate à Fraude
Retorno das fontes: Background checking
Validações: Regras