Cadastrar pessoas

É possível cadastrar pessoas físicas ou jurídicas. Alguns dados na nossa base de dados obrigatoriamente são únicos, sendo eles:

CPF, CNPJ, E-MAIL

Endpoints

Método	URL
POST	https://{{url}}/cube/api/v3/pessoas/cadastrar

Exemplo de corpo da requisição

Chave	Valor
nome*	Nome da pessoa ou razão social da empresa
nomeSocial	Nome social da pessoa quando pessoa física
nomeFantasia	Nome fantasia da empresa quando pessoa jurídica
dataNascimento	Data de nascimento da pessoa
email*	E-mail da pessoa
nomeMae	Nome da mãe da pessoa
rg	Número do RG
cpf**	Número do CPF quando pessoa física
cnpj**	Número do CNPJ quando pessoa jurídica
inscricaoEstadual	Número da inscrição estadual quando pessoa jurídica
tipoPessoa*	FISICA ou JURIDICA
cep	CEP do endereço, sem traços e pontos (exemplo 01415000)
logradouro	Nome do Logradouro
complemento	Complemento do Logradouro
pontoReferencia	Ponto de referência
bairro	Bairro
cidade	Cidade
uf	Estado
numeroLogradouro	Número do logradouro
idExterno	ID do sistema externo quando aplicável
telefones	Lista de objetos de telefone (ver exemplo abaixo). Uma lista de textos, como `["11987654321"]`, é recusada
telefone.ddd	DDD (Apenas números)
telefone.numero	Número do telefone
telefone.ramal	Número do ramal
telefone.preferencial	Booleano (true ou false), se é o telefone preferencial para contato

Exemplo de json de pessoa física

{
	"nome": "Yamada Taro",
	"dataNascimento": "06/06/1966",
	"email": "yamada@mycompany.com",
	"nomeMae": "Yamada Hanako",
	"rg": "112223332",
	"cpf": "111.222.333-45",
	"tipoPessoa": "FISICA",
	"cep": "01415000",
	"logradouro": "Rua pela cintra",
	"complemento": "CJ51",
	"pontoReferencia": "Ed. Rizkalla Jorge",
	"bairro": "Bela vista",
	"cidade": "Sao paulo",
	"uf": "SP",
	"numeroLogradouro": "1149",
	"telefones": [
		{
			"tipo": "COMERCIAL",
			"ddd": "11",
			"numero": "4890242",
			"ramal": "1",
			"preferencial": true
		}
	],
	"nomeSocial": "Tanaka",
	"idExterno": "1A2B3C4D5E"
}

tip

Os campos marcados com * são obrigatórios.

Respostas

Status	Descrição
200	OK - Pessoa cadastrada
400	Corpo da requisição ausente
400	Dados inválidos. A chave do erro vem em `errors[].attribute`: `tipoPessoa.obrigatorio`, `cpf.obrigatorio`, `cpf.invalido` ou `corpo.invalido` (formato do JSON inválido; `errors[].message` indica o campo, ex.: `telefones[0]`). Em desenvolvimento - ainda não disponível em produção.
409	CPF já cadastrado (`cpf.existente`). Em desenvolvimento - ainda não disponível em produção.
500	Erro - Falha ao criar a pessoa

tip

Antes de cadastrar, verifique se a pessoa já existe com Pesquisar pessoas.

Exemplo de resposta

{
	"success": "true",
	"idPessoa": 1
}

Permissões necessárias

Permissão	Descrição
seguranca:pessoas:cadastrar	Permite a o cadastro de pessoas no CUBE

Endpoints​

Exemplo de corpo da requisição​

Exemplo de json de pessoa física​

Respostas​

Exemplo de resposta​

Permissões necessárias​