Criar cliente

POST

/v1/clients

Cria um novo cliente (pessoa física ou jurídica) no cadastro da empresa autenticada. O cliente criado por este endpoint é um registro independente — não fica automaticamente vinculado a nenhum card — e passa a existir no cadastro geral de clientes da empresa, disponível para ser referenciado posteriormente em qualquer processo de crédito.

O corpo da requisição exige apenas companyId e taxId (CPF ou CNPJ, somente dígitos). O campo fields é opcional e recebe valores para os campos dinâmicos de cliente configurados pela empresa (o mesmo conjunto de campos configurável através do domínio de Configuração de Cliente) — cada posição do array representa um campo preenchido.

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 Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Cliente criado

O cliente foi criado com sucesso.

Esta resposta não possui corpo.

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/clients' \
--header 'ag-flow-id;' \
--header 'Content-Type: application/json' \
--data '{
    "companyId": "string",
    "taxId": "string",
    "fields": [
        [
            "string"
        ]
    ]
}'

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

Página anterior

Listar cards do cliente

Próxima página

Obter cliente