POST
Executa consultas para um documento e retorna os resultados normalizados (best-effort por tipo).
Executa uma ou mais consultas para um documento (CPF/CNPJ) e retorna os resultados normalizados na mesma resposta. Informe o document e a lista de types (ver Listar tipos). A execução é best-effort por tipo: cada tipo que dá certo entra em results (com o resultado normalizado em data + uma reference para releitura); cada tipo que falha entra em failures com o motivo, sem interromper os demais e sem custo para o que falhou.
Para o SCR, use scrPeriod no formato "yyyy-MM" (mês de referência). Se omitido, usa-se o mês anterior. Tipos que não usam mês de referência ignoram o campo.
Para a Consulta Veicular (tipo 103), informe plate com a placa do veículo (formato ABC1234 ou ABC1D23). É o único tipo que usa esse campo, e os demais o ignoram. Sem uma placa válida, o tipo 103 volta em failures e nada é cobrado por ele.
O Serasa (tipo 104) atende somente CPF. Enviá-lo para um CNPJ faz o tipo voltar em failures. Confira acceptsCpf e acceptsCnpj em Listar tipos.

O campo data por tipo

O data de cada resultado varia conforme o type:
Score, Restrições, Protestos, Pendências, Limites, SCR, KYC, Consulta Veicular e Serasa são executáveis por aqui. Renda, Dados Básicos, Notícias e Processos podem aparecer no seu histórico (originados por outros fluxos), mas não constam em Listar tipos.

Body

Dados para executar uma ou mais consultas para um documento.

document
string | null

CPF ou CNPJ do consultado (com ou sem máscara).

types
integer<int32>[] | null

Tipos de consulta a executar (ver ListarTipos).

scrPeriod
string | null

Período do SCR como "yyyy-MM". Ignorado por tipos sem mês de referência. Nulo = mês anterior.

plate
string | null

Placa do veiculo. Obrigatoria quando o tipo 103 esta selecionado; os demais tipos ignoram.

Response

OK

Resultado de uma execução de consulta (best-effort por tipo).

results
object[] | null

Resultados normalizados dos tipos que tiveram sucesso.

failures
object[] | null

Tipos que falharam, com o motivo.