Cadastrar grupo econômico expandido

POST

/groups/group-expanded

Cadastra um grupo econômico expandido vinculado a um cliente de referência (clientId), ou reaproveita o grupo já existente para esse cliente caso um já tenha sido criado anteriormente — não é permitido mais de um grupo expandido por clientId.

Aceita uma lista de CPF/CNPJ (clients) para vincular ao grupo: clientes ainda não cadastrados na empresa são criados automaticamente (sujeitos às mesmas validações de bureau do cadastro em lote, incluindo o bloqueio de CPF de menor de idade); clientes já cadastrados são apenas vinculados ao grupo, com nome e dados básicos preenchidos se estiverem faltando. Retorna erro se o cliente já pertencer a esse mesmo grupo.

Após vincular os clientes, a rota também solicita automaticamente as consultas informadas em products para cada cliente adicionado ao grupo (ex.: SCR, Sintegra, compliance) — diferente da rota POST /groups/, que apenas cria o agrupamento sem disparar consultas.

Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Harvested 201

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/groups/group-expanded' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": "string",
    "name": "string",
    "clients": [
        "string"
    ],
    "products": [
        "string"
    ]
}'

Response Example

201 - Sucesso

{
    "id": "d6c06a8f-2df4-470d-9391-9fee5d139343",
    "name": "teste-documentação",
    "kind": "group",
    "items": [
        {
            "id": "3bfaab5f-7586-4db2-8d6f-7d173eff1912",
            "kind": "natural",
            "taxId": "***********",
            "groupId": "d6c06a8f-2df4-470d-9391-9fee5d139343"
        }
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Listar grupos

Próxima página

Listar clientes de um grupo