Obter cliente

GET

/v1/clients/{clientId}

Retorna o perfil completo de um cliente específico — dados cadastrais, situação do documento na Receita Federal, informações societárias (para pessoa jurídica) ou pessoais (para pessoa física), contatos e os campos dinâmicos configurados pela empresa.

O shape da resposta varia conforme o tipo de cliente (kind): campos como motherName/fatherName/gender/birthDate/marital fazem sentido para pessoa física (natural); já tradeName/legalNature/partners/capital/nire fazem sentido para pessoa jurídica (legal). Nem todo campo estará necessariamente preenchido para todo cliente.

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

🟢200Detalhes do cliente

application/json

Perfil completo do cliente.

Bodyapplication/json

Response Example

{
    "id": "string",
    "refId": "string",
    "companyId": "string",
    "taxId": "string",
    "kind": "natural",
    "active": true,
    "name": "string",
    "tradeName": "string",
    "scrAuthorized": true,
    "score": 0,
    "rating": "string",
    "age": 0,
    "gender": "string",
    "birthDate": "string",
    "motherName": "string",
    "fatherName": "string",
    "marital": {
        "status": "divorced",
        "source": "string"
    },
    "taxIdStatus": "string",
    "hasObitIndication": true,
    "foundedDate": "string",
    "legalNature": {
        "code": "string",
        "activity": "string"
    },
    "activities": [
        {
            "activity": "primary",
            "code": "string",
            "description": "string"
        }
    ],
    "capital": 0,
    "partners": {},
    "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"
        }
    ],
    "createdAt": "string",
    "updatedAt": "string",
    "fields": [
        {
            "id": "string",
            "name": "string",
            "category": "conditional",
            "value": null,
            "type": "string",
            "required": true
        }
    ]
}

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