Pular para o conteúdo principal

Registrar Pessoa Física

Conceituação#

Neste método você pode cadastrar uma pessoa física


Método#

Para registrar a pessoa física, usaremos o método: /api/v3/person/individual-person

POST https://api.kigisistemas.com.br/mobiage-api/api/v3/person/individual-person

Neste método usaremos as Headers:

KEYVALUE
Content-Typeapplication/json
gumgaTokenSeu Token

Atributos#

Opcionais#


Request Params#

POST https://api.kigisistemas.com.br/mobiage-api/api/v3/person/individual-person

Response#

200#

AtributosTipoDescrição
thirdIdstringid da pessoa
registerNamestringNome de registro da pessoa
socialNamestringNome social da pessoa
federalDocumentstringCPF da pessoa sem pontuação
stateDocumentstringRG da pessoa sem pontuação
emissionOrgstringÓrgão emissor do documento estadual
emissionStatestringEstado de emissão do documento
telephonesstring[]Lista de telefones
emailsstring[]Lista de e-mails
adressesAddress[]Lista de endereços
genderstringGênero da pessoa
activebooleanIndica se o cadastro está ativo
urlPhotostringURL de uma foto da pessoa
rolesRole[]Lista de papéis da pessoa
naturalnessstringNaturalidade da pessoa
tagsstring[]Lista de tags
creditLimitdecimalLimite de crédito para vendas no crediário
registrationDateDateData de criação do cadastro

gender#

TipoDescrição
stringopções: MASC -[masculino] ou FEM-[feminino] ou NINF-[não-infomado]

Address {array}#

AtributoTipoDescrição
zipCodestringCEP sem pontuação
premissestringLocalização. Exemplo: Avenida Paulista
numberstringNúmero da localização
informationstringComplemento do endereço
neighbourhoodstringBairro do endereço
localizationstringCidade
statestringEstado. Exemplo: SP, PR, SC, ES, etc.
countrystringPaís. Exemplo: Brasil
formalCodestringcódigo IBGE da cidade
stateCodestringcódigo do estado
isPrimarystringidentifica se o endereço é o principal ou não

roles {array}#

TipoDescrição
stringopções: [CLIENT -[cliente], TRANSPORTER-[transportadora], PROVIDER-[fornecedor], SHOPPING_GUIDE-[guia de compras]

stateIndicator#

TipoDescrição
stringopções: CONTRIBUINTE ou ISENTO ou NAO_CONTRIBUINTE

Exemplo

{
"thirdId": 32232,
"registerName": "Cliente novo",
"roles": ["CLIENT"],
"federalDocument": "00000000000",
"adresses": [
{
"zipCode": "00000000",
"premisse": "Avenida Paulista",
"number": "1060",
"neighbourhood": "Zona 07",
"localization": "São Paulo",
"state": "PR",
"country": "Brasil",
"formalCode": "222222",
"stateCode": "33",
"isPrimary": true
}
]
}
____________________________________________________________________________________