Get client

GET

/v1/clients/{clientId}

Returns the full profile of a specific client — registration data, tax-document status with the federal revenue service, corporate information (for legal entities) or personal information (for individuals), contact details, and the dynamic fields configured by the company.

The response shape varies according to the client type (kind): fields such as motherName/fatherName/gender/birthDate/marital are meaningful for individuals (natural), while tradeName/legalNature/partners/capital/nire are meaningful for legal entities (legal). Not every field will necessarily be filled in for every client.

The ag-flow-id header is optional on these calls; when provided, it identifies an existing company flow (available from GET /v1/flows, Flow domain, or from the flow's URL in the AgFlow application) — omitting it does not block the call.

Requisição

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200Client details

application/json

Full client profile.

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