Consultar dados AgRisk do cliente

GET

/v1/clients/{clientId}/agrisk

Retorna os dados básicos de um cliente obtidos junto às fontes externas consultadas automaticamente (ver domínio Consulta a Bureau) — nome, documento, situação cadastral, dados demográficos e contatos (endereços, e-mails, telefones) e o score de análise mais recente, quando disponível.

Este endpoint é uma visão consolidada e mais enxuta do resultado da consulta externa, complementar ao perfil completo do cliente (endpoint de obtenção individual).

O cabeçalho ag-flow-id é opcional nestas chamadas; quando enviado, identifica um flow existente da empresa (disponível em GET /v1/flows, domínio Fluxo, ou na URL do flow na aplicação AgFlow) — omiti-lo não impede a chamada.

Requisição

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200Dados AgRisk do cliente

application/json

Dados básicos consolidados do cliente.

Bodyapplication/json

Response Example

{
    "id": "string",
    "companyId": "string",
    "taxId": "string",
    "kind": "natural",
    "active": true,
    "name": "string",
    "gender": "string",
    "birthDate": "string",
    "age": 0,
    "motherName": "string",
    "fatherName": "string",
    "taxIdStatus": "string",
    "hasObitIndication": true,
    "maritalStatus": "string",
    "scrAuthorized": true,
    "detailScore": {
        "score": 0,
        "rating": "string",
        "calculatedAt": "string"
    },
    "addresses": [
        {
            "type": "HOME",
            "country": "string",
            "state": "string",
            "city": "string",
            "address": "string",
            "zipCode": "string"
        }
    ],
    "emails": [
        {
            "type": "PERSONAL",
            "email": "string"
        }
    ],
    "phones": [
        {
            "type": "HOME",
            "number": "string",
            "areaCode": "string"
        }
    ]
}

Modificado em 2026-07-29 13:10:05

Página anterior

Clientes — Visão geral

Próxima página

Listar cards do cliente