6.1. Payload Completo e Mapeamento
Nesta seção é apresentado o payload completo de um cadastro de cedente com todos os dados necessários.
Dica
Os campos marcados com 🟢 são obrigatórios. Os campos marcados com 🟥 são opcionais mas recomendados para garantir um cadastro completo.
Exemplo Completo — Cadastro Passo a Passo¶
Passo 1: Criar a Empresa Cedente¶
| Método | URL |
|---|---|
 | https://BASE_URL/api/cedentes |
POST /api/cedentes
{
"cnpj": "12345678000199",
"nome": "ABC Indústria e Comércio LTDA",
"razaoSocial": "ABC Indústria e Comércio Sociedade Limitada",
"email": "financeiro@abc-industria.com.br",
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "31234567"
},
"tipoPessoa": 2,
"inscricaoEstadual": "123456789012",
"isentoInscricaoEstadual": false,
"inscricaoMunicipal": "CCM-987654",
"endereco": {
"logradouro": "Avenida Paulista",
"numero": "1000",
"complemento": "12º Andar, Conj. 1201",
"bairro": "Bela Vista",
"cep": "01310-100",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"codigoCnae": "2599-3/99",
"naturezaJuridica": "206-2",
"objetoSocial": "Fabricação e comércio de peças metálicas para a indústria automotiva.",
"dataConstituicao": "2008-06-15",
"faturamento": 12000000.00,
"porte": 4,
"integranteSnf": false,
"ramoAtividade": "INDUSTRIA",
"tipoSociedade": "LTDA",
"classificacaoRisco": 2,
"autorizacaoCessao": "SIM",
"codigoCoobrigacaoCedente": "A",
"siteCorporativo": "https://abc-industria.com.br",
"dataContrato": "2025-01-10"
}
Passo 2: Adicionar Sócio e Representante Legal¶
| Método | URL |
|---|---|
| https://BASE_URL/api/cedentes/{idEmpresa}/pessoas |
POST /api/cedentes/123/pessoas — Sócio + Representante
{
"nome": "Roberto Almeida",
"cpfCnpj": "11122233344",
"email": "roberto@abc-industria.com.br",
"rg": "12.345.678-9",
"estadoCivil": 2,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Engenheiro Mecânico",
"endereco": {
"logradouro": "Rua Augusta",
"numero": "500",
"complemento": "Apto 1501",
"bairro": "Consolação",
"cep": "01304-000",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "999001122"
},
"papelSocio": true,
"papelRepresentante": true,
"papelAvalista": false,
"participacao": 60.00,
"tipoParteRelacionada": 1,
"beneficiarioDireto": true,
"ehRepresentante": true,
"regimeBens": "partial_communion_of_goods",
"assinaIsoladamente": true,
"emiteDuplicata": true,
"assinaPorEndosso": true,
"assinaTermoCessao": true
}
POST /api/cedentes/123/pessoas — Sócio Minoritário
{
"nome": "Ana Costa",
"cpfCnpj": "55566677788",
"email": "ana.costa@abc-industria.com.br",
"estadoCivil": 1,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Administradora",
"endereco": {
"logradouro": "Rua Oscar Freire",
"numero": "200",
"bairro": "Pinheiros",
"cep": "05409-010",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "988776655"
},
"papelSocio": true,
"papelRepresentante": false,
"papelAvalista": false,
"participacao": 40.00,
"tipoParteRelacionada": 2,
"beneficiarioDireto": true,
"ehRepresentante": false
}
Passo 3: Adicionar Avalista (Pessoa Física)¶
POST /api/cedentes/123/pessoas — Avalista PF
{
"nome": "Carlos Eduardo Martins",
"cpfCnpj": "99988877766",
"email": "carlos.martins@email.com",
"rg": "98.765.432-1",
"estadoCivil": 2,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Empresário",
"endereco": {
"logradouro": "Alameda Santos",
"numero": "800",
"complemento": "Apto 302",
"bairro": "Cerqueira César",
"cep": "01418-100",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "977665544"
},
"papelSocio": false,
"papelRepresentante": false,
"papelAvalista": true,
"regimeBens": "total_separation_of_goods"
}
Passo 4: Adicionar Conta Corrente¶
| Método | URL |
|---|---|
| https://BASE_URL/api/cedentes/{idEmpresa}/contas |
POST /api/cedentes/123/contas
{
"codigoBanco": "341",
"agencia": "1234",
"conta": "56789",
"digito": "0",
"tipoConta": 1,
"descricao": "Conta principal operações"
}
Passo 5: Adicionar Contatos¶
| Método | URL |
|---|---|
| https://BASE_URL/api/cedentes/{idEmpresa}/contatos |
POST /api/cedentes/123/contatos — Contato financeiro
{
"nome": "Patrícia Oliveira",
"email": "patricia@abc-industria.com.br",
"telefone": "11988001122"
}
POST /api/cedentes/123/contatos — Contato operacional
{
"nome": "Fernando Souza",
"email": "fernando@abc-industria.com.br",
"telefone": "11977002233"
}
Passo 6: Upload de Documentos¶
| Método | URL |
|---|---|
| https://BASE_URL/api/cedentes/{idEmpresa}/documentos |
Upload — Contrato Social da Empresa
curl -X POST https://BASE_URL/api/cedentes/123/documentos \
-H "Authorization: Bearer {token}" \
-F "arquivo=@contrato_social.pdf" \
-F "tipoDocumentoIntegracao=social_contract" \
-F "observacao=Contrato social consolidado 2025"
Upload — CNH do Sócio (vinculada à pessoa)
curl -X POST https://BASE_URL/api/cedentes/123/documentos \
-H "Authorization: Bearer {token}" \
-F "arquivo=@cnh_roberto.pdf" \
-F "tipoDocumentoIntegracao=cnh" \
-F "idEmpresaPessoa=45"
Upload — Balanço Patrimonial
curl -X POST https://BASE_URL/api/cedentes/123/documentos \
-H "Authorization: Bearer {token}" \
-F "arquivo=@balanco_2024.pdf" \
-F "tipoDocumentoIntegracao=balance_sheet"
Resultado Final — Consulta Completa¶
| Método | URL |
|---|---|
 | https://BASE_URL/api/cedentes/123 |
GET /api/cedentes/123 — Response Body
{
"idEmpresa": 123,
"empresa": {
"cnpj": "12345678000199",
"nome": "ABC Indústria e Comércio LTDA",
"razaoSocial": "ABC Indústria e Comércio Sociedade Limitada",
"email": "financeiro@abc-industria.com.br",
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "31234567"
},
"tipoPessoa": 2,
"inscricaoEstadual": "123456789012",
"isentoInscricaoEstadual": false,
"inscricaoMunicipal": "CCM-987654",
"endereco": {
"logradouro": "Avenida Paulista",
"numero": "1000",
"complemento": "12º Andar, Conj. 1201",
"bairro": "Bela Vista",
"cep": "01310-100",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"codigoCnae": "2599-3/99",
"naturezaJuridica": "206-2",
"objetoSocial": "Fabricação e comércio de peças metálicas para a indústria automotiva.",
"dataConstituicao": "2008-06-15",
"faturamento": 12000000.00,
"porte": 4,
"integranteSnf": false,
"ramoAtividade": "INDUSTRIA",
"tipoSociedade": "LTDA",
"classificacaoRisco": 2,
"autorizacaoCessao": "SIM",
"codigoCoobrigacaoCedente": "A",
"siteCorporativo": "https://abc-industria.com.br",
"dataContrato": "2025-01-10"
},
"pessoas": [
{
"idPessoa": 45,
"nome": "Roberto Almeida",
"cpfCnpj": "11122233344",
"email": "roberto@abc-industria.com.br",
"rg": "12.345.678-9",
"estadoCivil": 2,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Engenheiro Mecânico",
"endereco": {
"logradouro": "Rua Augusta",
"numero": "500",
"complemento": "Apto 1501",
"bairro": "Consolação",
"cep": "01304-000",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "999001122"
},
"papelSocio": true,
"papelRepresentante": true,
"papelAvalista": false,
"participacao": 60.00,
"tipoParteRelacionada": 1,
"beneficiarioDireto": true,
"ehRepresentante": true,
"regimeBens": "partial_communion_of_goods",
"assinaIsoladamente": true,
"emiteDuplicata": true,
"assinaPorEndosso": true,
"assinaTermoCessao": true,
"pessoasFilhas": []
},
{
"idPessoa": 46,
"nome": "Ana Costa",
"cpfCnpj": "55566677788",
"email": "ana.costa@abc-industria.com.br",
"estadoCivil": 1,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Administradora",
"endereco": {
"logradouro": "Rua Oscar Freire",
"numero": "200",
"bairro": "Pinheiros",
"cep": "05409-010",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "988776655"
},
"papelSocio": true,
"papelRepresentante": false,
"papelAvalista": false,
"participacao": 40.00,
"tipoParteRelacionada": 2,
"beneficiarioDireto": true,
"ehRepresentante": false,
"pessoasFilhas": []
},
{
"idPessoa": 47,
"nome": "Carlos Eduardo Martins",
"cpfCnpj": "99988877766",
"email": "carlos.martins@email.com",
"rg": "98.765.432-1",
"estadoCivil": 2,
"tipoPessoa": 1,
"nacionalidade": "BRA",
"profissao": "Empresário",
"endereco": {
"logradouro": "Alameda Santos",
"numero": "800",
"complemento": "Apto 302",
"bairro": "Cerqueira César",
"cep": "01418-100",
"cidade": "São Paulo",
"uf": "SP",
"pais": "BRA"
},
"telefone": {
"ddi": "+55",
"ddd": "11",
"numero": "977665544"
},
"papelSocio": false,
"papelRepresentante": false,
"papelAvalista": true,
"regimeBens": "total_separation_of_goods",
"pessoasFilhas": []
}
],
"contasCorrentes": [
{
"idConta": 10,
"codigoBanco": "341",
"nomeBanco": "Itaú Unibanco",
"agencia": "1234",
"conta": "56789",
"digito": "0",
"tipoConta": 1,
"descricao": "Conta principal operações"
}
],
"contatos": [
{
"idContato": 5,
"nome": "Patrícia Oliveira",
"email": "patricia@abc-industria.com.br",
"telefone": "11988001122"
},
{
"idContato": 6,
"nome": "Fernando Souza",
"email": "fernando@abc-industria.com.br",
"telefone": "11977002233"
}
],
"documentos": [
{
"idDocumento": 78,
"arquivoNome": "contrato_social.pdf",
"tipoDocumentoIntegracao": "social_contract",
"statusDocumento": "created",
"idEmpresaPessoa": null,
"observacao": "Contrato social consolidado 2025"
},
{
"idDocumento": 79,
"arquivoNome": "cnh_roberto.pdf",
"tipoDocumentoIntegracao": "cnh",
"statusDocumento": "created",
"idEmpresaPessoa": 45,
"observacao": null
},
{
"idDocumento": 80,
"arquivoNome": "balanco_2024.pdf",
"tipoDocumentoIntegracao": "balance_sheet",
"statusDocumento": "created",
"idEmpresaPessoa": null,
"observacao": null
}
]
}