Solicitar consulta de negativação

POST

/v2/billing/negativation/clients/{clientId}

Solicita a consulta de negativação para o CPF/CNPJ informado (taxId), a partir do cliente de origem indicado na URL. Cadastra o consultado como cliente se ele ainda não existir, debita o saldo e registra o faturamento. O taxId aceita somente dígitos, com 11 ou 14 posições, e precisa ser um CPF/CNPJ válido. Requer que o perfil do usuário tenha o produto de negativação liberado em consulta ou consulta_individual, além de autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Inferred 201 (from source code)

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/billing/negativation/clients/CLIENT_ID' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "taxId": "string",
    "companyId": "string",
    "codeAgFlow": "string"
}'

Response Example

201 - Sucesso

{
    "_id": "string",
    "companyId": "string",
    "clientId": "string",
    "userId": "string",
    "products": [
        "string"
    ],
    "status": [
        {
            "product": "string",
            "status": "FILA",
            "taxId": "string",
            "services": [
                {
                    "service": "string",
                    "status": "FILA"
                }
            ]
        }
    ]
}

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

Página anterior

Solicitar valores de tipologia dos imóveis CAR de um cliente

Próxima página

Visualizar restritivos de crédito de um cliente