Gerenciamento das pessoas vinculadas ao cedente: sócios, representantes legais e avalistas.
Uma mesma pessoa pode acumular múltiplos papéis (ex.: sócio e representante legal ao mesmo tempo).
Adicionar Pessoa¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/pessoas |
Request Body
{
"nome": "João da Silva",
"cpfCnpj": "12345678901",
"email": "joao.silva@email.com",
"rg": "1234567",
"estadoCivil": 2,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Empresário",
"endereco": {
"logradouro": "Rua das Flores",
"numero": "100",
"complemento": "Apto 301",
"bairro": "Jardim Europa",
"cep": "89020-000",
"cidade": "Blumenau",
"uf": "SC",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "47",
"numero": "999887766"
},
"papelSocio": true,
"papelRepresentante": true,
"papelAvalista": false,
"participacao": 50.00,
"tipoParteRelacionada": 2,
"beneficiarioDireto": true,
"ehRepresentante": true,
"regimeBens": "partial_communion_of_goods",
"assinaIsoladamente": true,
"emiteDuplicata": false,
"assinaPorEndosso": true,
"assinaTermoCessao": true
}
Response Body
{
"idPessoa": 45,
"idEmpresa": 123,
"nome": "João da Silva",
"status": "Pessoa adicionada com sucesso."
}
Atualizar Pessoa¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/pessoas/{idPessoa} |
O payload possui a mesma estrutura da adição. Somente os campos enviados serão atualizados.
Request Body
{
"participacao": 60.00,
"papelAvalista": true
}
Response Body
{
"idPessoa": 45,
"status": "Pessoa atualizada com sucesso."
}
Remover Pessoa¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/pessoas/{idPessoa} |
Response Body
{
"status": "Pessoa removida com sucesso."
}
Modelo de Dados¶
Requisição — Pessoa¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome | Texto (200) | ✅ | Nome completo da pessoa |
cpfCnpj | Texto (18) | ✅ | CPF (PF) ou CNPJ (PJ avalista) |
email | Texto (200) | ✅ | E-mail da pessoa |
rg | Texto (20) | Opcional | Número do RG |
estadoCivil | Número | Opcional | Estado civil. Ver Estado Civil |
tipoPessoa | Número | Opcional | Tipo de pessoa (1=PF, 2=PJ). Ver Tipo de Pessoa. Default: 1 |
nacionalidade | Texto (3) | Opcional | Nacionalidade (ISO 3166-1 alpha-3). Default: BRA |
passaporte | Texto (20) | Opcional | Número do passaporte (para estrangeiros sem CPF) |
profissao | Texto (100) | Opcional | Profissão |
endereco | Endereço | ✅¹ | Endereço residencial |
telefone | Telefone | Opcional | Telefone de contato |
papelSocio | Booleano | ✅ | Se a pessoa é sócio/acionista |
papelRepresentante | Booleano | ✅ | Se a pessoa é representante legal |
papelAvalista | Booleano | ✅ | Se a pessoa é avalista |
participacao | Decimal | Opcional² | Percentual de participação societária (0 a 100) |
tipoParteRelacionada | Número | Opcional | Tipo da parte relacionada. Ver Tipo de Parte Relacionada |
beneficiarioDireto | Booleano | Opcional | Se é beneficiário direto (true) ou indireto (false) |
ehRepresentante | Booleano | Opcional | Se é representante assinante |
regimeBens | Texto | Opcional | Regime de bens. Ver Regime de Bens |
empresaEloPais | Texto (3) | Opcional | País da empresa intermediária (beneficiário indireto, ISO alpha-3) |
empresaEloRegistro | Texto (30) | Opcional | Registro da empresa intermediária (beneficiário indireto) |
assinaIsoladamente | Booleano | Opcional | Se assina isoladamente (representante). Default: false |
emiteDuplicata | Booleano | Opcional | Se emite duplicata (representante). Default: false |
assinaPorEndosso | Booleano | Opcional | Se assina por endosso (representante). Default: false |
assinaTermoCessao | Booleano | Opcional | Se assina termo de cessão (representante). Default: false |
Notas
¹ Obrigatório para avalistas.
² Obrigatório quando papelSocio = true.
Pessoa Jurídica como Avalista¶
Quando o avalista é uma Pessoa Jurídica (tipoPessoa = 2), é possível vincular seus representantes como pessoas filhas. Para isso, adicione os representantes com o campo idPessoaPai referenciando o ID do avalista PJ:
Request Body — Representante de Avalista PJ
{
"nome": "Carlos Representante",
"cpfCnpj": "98765432100",
"email": "carlos@avalistapj.com.br",
"tipoPessoa": 1,
"nacionalidade": "BRA",
"papelSocio": false,
"papelRepresentante": true,
"papelAvalista": false,
"idPessoaPai": 45
}
Na consulta do cedente, os representantes de avalistas PJ são retornados no array pessoasFilhas dentro do objeto do avalista.
Retorno¶
| Campo | Tipo | Descrição |
|---|---|---|
idPessoa | Número | ID da pessoa criada/atualizada |
idEmpresa | Número | ID da empresa cedente |
nome | Texto | Nome da pessoa |
status | Texto | Mensagem de status da operação |