Consultar dados cadastrais de um cliente

GET

/clients/client/{clientId}

Devolve os dados cadastrais do cliente informado em clientId e o score AgRisk mais recente dele. A resposta depende do tipo do cliente. Pessoa física (kind natural) traz gender, birthDate, age (calculada pela data de nascimento, quando ela existe), motherName, fatherName, taxIdStatus, hasObitIndication, obitIndicationYear, lastUpdateDate, alternativeIdNumbers e maritalStatus. Pessoa jurídica (kind legal) traz taxIdStatus, foundedDate, age, legalNature (activity), additionalOutputData (capital) e partners, com os sócios atuais e anteriores, cada um com name e taxId. groupId só vem quando o cliente pertence a um grupo. detailScore traz score, rating e calculatedAt do score mais recente do cliente, ou null quando não há; message vem preenchida quando o score devolvido é o do cache de score: "Solicite uma consulta completa para um score mais atualizado." quando há score, ou "Score AgRisk não disponível." quando não há. Clientes removidos também são devolvidos. 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

Dados cadastrais do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/clients/client/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Pessoa física

{
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "kind": "natural",
    "taxId": "52998224725",
    "name": "CLIENTE EXEMPLO DA SILVA",
    "gender": "M",
    "birthDate": "1980-05-12T00:00:00Z",
    "age": 46,
    "motherName": "MARIA EXEMPLO DA SILVA",
    "fatherName": "JOSE EXEMPLO DA SILVA",
    "taxIdStatus": "REGULAR",
    "hasObitIndication": false,
    "obitIndicationYear": null,
    "lastUpdateDate": "2026-06-08T00:00:00Z",
    "alternativeIdNumbers": {},
    "maritalStatus": "CASADO",
    "detailScore": {
        "score": 650,
        "rating": "B",
        "calculatedAt": "2026-09-02T17:23:41.829Z",
        "message": "Solicite uma consulta completa para um score mais atualizado."
    }
}

Modificado em 2026-10-05 16:44:23

Página anterior

Listar contatos de um cliente

Próxima página

Listar registros do BNDES de um cliente