Visualizar Boa Vista de um cliente

GET

/queries/clients/{clientId}/bvs/{queryId}

Devolve o resultado do Boa Vista do cliente informado em clientId, na consulta informada em queryId. O queryId é o identificador da consulta em que o serviço foi solicitado: o mesmo que a solicitação da consulta devolve e que a rota de consultas do cliente lista por serviço. A resposta traz id, clientId, queryId, createdAt e updatedAt e os blocos defineModular e essential, cada um presente só quando o resultado gravado o contém. Vários campos sem valor, ou com valor 0, não aparecem. Consulta inexistente devolve 404. Quando a consulta existe mas não há resultado do Boa Vista para este cliente nela, a resposta é 200 com a mensagem "Cliente não possui dados do boa vista." e statusCode 200 no corpo, no lugar dos dados. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

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

Respostas

🟢200

application/json

Resultado do Boa Vista do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404Consulta, cliente ou usuário não encontrados

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/bvs/3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso (defineModular)

{
    "id": "9d8c7b6a-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "queryId": "3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13",
    "defineModular": {
        "basicIdentification": {
            "taxId": "11222333000181",
            "legalName": "AGRO EXEMPLO S.A.",
            "tradeName": "AGRO EXEMPLO",
            "situation": "ATIVA",
            "situationDate": "2020-01-15",
            "queryDate": "2026-09-18",
            "startingDate": "2010-03-01",
            "juridicalNatureCode": "2054",
            "juridicalNature": "SOCIEDADE ANONIMA FECHADA",
            "activityBranch": {
                "activity": "CULTIVO DE SOJA",
                "cnae": "0115600"
            }
        },
        "pendenciesRestrictions": {
            "totalPendencies": 2,
            "totalCreditors": 1,
            "value": 15230.5,
            "startingDate": "2025-02-10",
            "endingDate": "2026-06-30",
            "firstValue": 5000,
            "firstDate": "2025-02-10",
            "biggestValue": 10230.5,
            "biggestDate": "2026-06-30",
            "lastOccurrences": {
                "pendencyRestriction": [
                    {
                        "informer": "CREDOR EXEMPLO",
                        "type": "FINANCIAMENTO",
                        "city": "SORRISO",
                        "state": "MT",
                        "documentSource": "11222333000181",
                        "debtDate": "2026-06-30",
                        "publicationDate": "2026-07-05",
                        "value": 10230.5
                    }
                ]
            }
        },
        "scoreClassification": {
            "score": "650",
            "scoreModel": "Modelo Exemplo",
            "numericClassification": "6",
            "alphabeticClassification": "C",
            "probability": 12.5,
            "text": "Risco moderado."
        },
        "localeBasic": {
            "address": "RUA EXEMPLO, 100",
            "district": "CENTRO",
            "code": "78890000",
            "city": "SORRISO",
            "uf": "MT"
        }
    },
    "createdAt": "2026-09-18T14:02:40.118Z",
    "updatedAt": "2026-09-18T14:02:40.118Z"
}

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

Página anterior

Listar veículos de uma consulta

Próxima página

Visualizar protestos de um cliente