Requisição individual

Nesta sessão os relatórios são consultas individuais e possuem unicamente seus dados relativo a pesquisa e não contém nenhuma tipo de inteligência de decisão ou análise.

Requisição

Todos os relatórios são consultados por meio do único end-point:

POST /api/report

Parâmetros de requisição:

Os parâmetros da requisição devem ser enviados via Query Params. Logo abaixo temos um exemplo de como envia-los.

Campo	Descrição
report_id	Código do relatório a ser consultado. O código de cada relatório está descrito nas sessões a seguir, nos detalhamentos de cada relatório.
document	Número do documento a ser consultado.
trial	Enviar este parâmetro com o valor 1 durante o período de testes/integração. Para as consultas de produção, este parâmetro não deve ser enviado.

Alguns relatórios possuem parâmetros adicionais, alguns obrigatórios e ainda alguns relatórios possuem parâmetros diferentes dos parâmetros básicos padrão.

Consulte sempre a documentação do relatório para ver todos detalhes.

Exemplo de requisição em Testes:

curl
--location 
--request POST 'https://core.conhecaseucliente.com.br/api/report?report_id=cpf-register-basic&document=00000000191&trial=1' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SEU_TOKEN_AQUI'

Exemplo de requisição em Produção:

curl
--location 
--request POST 'https://core.conhecaseucliente.com.br/api/report?report_id=cpf-register-basic&document=00000000191' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SEU_TOKEN_AQUI'

Retornos

As requisições de relatórios retornam sempre uma estrutura principal, contendo o cabeçalho da consulta e o elemento report com o conteúdo de cada relatório individualizado. Você encontrará os detalhes de retorno de cada relatório individual nas sessões de relatórios disponíveis para consulta.

Parâmetros de resposta:

Campo	Descrição
id	Identificador único da transação (UUID).
created_at	Data hora da requisição.
report_id	Código de relatório solicitado
document	Documento para consulta solicitado.
status	Lista de Status: PROCESS SUCCESS UNAVAILABLE EXCEPTION ERROR
exception	Elemento JSON contendo a exceção.
exception.code	Código de exceção
exception.message	Descrição da exceção
report	Elemento JSON com o resultado do relatório solicitado.

Apenas as transações com status SUCCESS geram cobranças.

O status PROCESS é retornado nos relatórios que são de processamentos assíncronos. Neste caso, o resultado deve ser consultado através do endpoint de resultado de relatórios.

Os status UNAVAILABLE e ERROR representam alguma indisponibilidade momentânea no documento e/ou fonte de dados ou erros sistêmicos. Neste caso, a consulta pode ser requisitada novamente após alguns minutos.

O status EXCEPTION representa alguma limitação de negocio ou jurídica para a entrega dos dados. Neste caso, os dados não serão retornados para o documento solicitado.

Exemplo de resposta:

{
    "id": "cc16d7ee-a482-4207-b35f-4a928e97bc7a",
    "created_at": "2024-07-21T20:59:02-03:00",
    "report_id": "cpf-pep",
    "document": "00000000000",
    "status": "SUCCESS",
    "exception": {
        "code": 0,
        "message": null
    },
    "report": {
        // CONTEUDO DO RELATÓRIO SOLICITADO.
    }
}