# Integração com API

A CAF API segue o padrão REST (opens new window). Nossa API tem URLs orientadas a recursos previsíveis, aceita e retorna dados no formato JSON e usa códigos HTTP padrões na resposta.

# Endereço da API:

https://api.combateafraude.com/v1

# Respostas

Utilizamos os códigos de resposta convencionais para indicar sucesso ou falha em uma requisição. Em resumo, códigos no intervalo 2xx representam sucesso. Códigos no intervalo 4xx indicam algum erro de validação com as informações fornecidas ou falhas mapeadas. Códigos no intervalo 5xx indicam erro com os servidores ou qualquer outra falha não prevista.

Além disso, todas as respostas contam com um identificador da requisição, o campo requestId. Este campo é útil para encontrarmos a exata requisição em caso de investigação.

# Primeiros passos

  1. Obter token de acesso: tenha em mãos as credencias de acesso.
  2. Enviar documento para análise: inicie uma transação enviando as informações requisitadas.
  3. Consultar dados da transação: consulte os detalhes da transação.

Saiba mais:

  • Webhooks: informe um endpoint POST para receber notificações sobre o processamento da transação.