Solicitar consulta de flag de negativação

POST

/v2/negativation-flag/queries

Recebe um CPF ou CNPJ e inicia uma consulta assíncrona de restrição de crédito (negativação). O cliente correspondente ao CPF/CNPJ é sempre criado/resolvido dentro da empresa do token autenticado — não há parâmetro de empresa ou cliente de referência na requisição. Aceita opcionalmente um productId para usar um produto diferente do padrão (ex.: cobrança customizada por empresa) — quando ausente, usa o produto padrão avulso-flag-negativacao.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Consulta criada com sucesso

Bodyapplication/json

🟠400

🟠401

🟠403

🟠422

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/negativation-flag/queries' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "taxId": "string",
    "productId": "string"
}'

Response Example

201 - Sucesso

{
    "queryId": "string"
}

Modificado em 2026-10-13 09:47:06

Página anterior

Listar consultas mais recentes de um cliente

Próxima página

Visualizar resumo de uma consulta