Requisição de Relatório

Os relatórios são consultas individuais e possuem unicamente os dados relativo ao documento pesquisado. Deve-se usar a mesma endpoint utilizando o código do relatório desejado.

O código de cada relatório está descrito nas sessões a seguir, nos detalhamentos de cada relatório.

Requisição Base

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

POST /api/report

Parâmetros da requisição

Os parâmetros base da requisição devem ser enviados via Data Raw JSON no body da requisição.

Campo	Descrição
report_id	Obrigatório. Código do relatório a ser consultado.
document	Obrigatório. Numeração do documento a ser consultado.
external_id	Opcional. Id de identificação da transação no seu sistema. (Char 36)
trial	Opcional. Enviar este parâmetro com o valor true durante o período de testes/integração. Para as consultas de produção, NÃO DEVE ser enviado.

INFO

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 específico para ver todos detalhes.

Ambiente de Homologação e Testes

Devido da dinâmica de diversas combinações de resultados possíveis entre todos os relatórios, não possuímos um ambiente exclusivo para homologação. Deve-se utilizar para este fim, a requisição direto em ambiente de produção com uma flag de nome "trial" onde estas requisições não serão cobradas. O número de chamadas em trail é limitado, em caso de atingir o limite, acione seu gerente de contas.

Exemplo de requisição para Testes / Integração

curl
--location 
--request POST 'https://core.scorepositivo.com.br/api/report' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SEU_TOKEN_AQUI'
--data '{
    "report_id":"cpf-register",
    "document":"00000000000",
    "trial":true
}'

Exemplo de requisição em Produção

curl
--location 
--request POST 'https://core.scorepositivo.com.br/api/report' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer SEU_TOKEN_AQUI'
--data '{
    "report_id":"cpf-register",
    "document":"00000000000"
}'

Retornos

As requisições de relatórios retornam em 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. (em GTM -03:00)
report_id	Código do relatório solicitado
document	Documento da consulta
status	Lista de status: PROCESS SUCCESS UNAVAILABLE EXCEPTION ERROR Ver detalhamento dos Status mais abaixo
code	Código para descrição complementar do status. Confira a Tabela de Mensagens para mais detalhes.
report	Elemento JSON com o resultado do relatório solicitado.

{    
    "id": "1876d480-5d69-4d7f-8f03-b83ba02fc605",
    "created_at": "2024-07-23T18:57:52-03:00",
    "report_id":"cpf-register",
    "document":"00000000000",
    "status": "SUCCESS",
    "code": 0,
    "report": {
        //CONTEUDO DO RELATÓRIO
    } 
}

INFO

PROCESS O status PROCESS é retornado para os relatórios de processamentos assíncronos. Neste caso, o resultado deve ser consultado através do endpoint de resultado de relatórios. O status PROCESS é o único status mutável, pois até o SLA limite do relatório, ele se tornará em algum dos status a seguir.

SUCCESS O status SUCCESS é retornado para relatórios executado com sucesso. Nem sempre isso implica em retorno de dados, alguns relatórios consultam justamente a falta de apontamentos no documento consultado. As transações com status SUCCESS são as únicas que geram cobranças.

UNAVAILABLE e ERROR Os status UNAVAILABLE e ERROR representam alguma indisponibilidade momentânea no documento e/ou fonte de dados ou ainda erros sistêmicos. Neste caso, a consulta pode ser requisitada novamente após alguns minutos ou após algum momento maior, conforme descrição da mensagem de retorno.

EXCEPTION O status EXCEPTION representa alguma limitação de negócio ou jurídica para a entrega dos dados. Neste caso, os dados não serão retornados para o documento solicitado, até que o documento deixe de ter a restrição aplicada.