Incluir uma pessoa

Cria uma pessoa a partir do CPF ou CNPJ. O tipo (PF ou PJ) vem do próprio documento,
não do corpo: aceitar o campo permitiria mandar PF com CNPJ e a pessoa nasceria com o
tipo conflitando com o documento.

O documento é validado com dígito verificador, e documento já cadastrado é 409 com o id
da pessoa existente: criar a segunda faria toda resolução por documento passar a devolver
ambiguidade depois.

Bairro, banco, profissão e os tipos (telefone, e-mail, endereço, documento, relação) vão
por nome, resolvidos neste convênio. Nome inexistente é 422, nunca cadastro auxiliar
criado em silêncio. Os catálogos estão em GET /pub/v1/schema/lookups.

relationshipTypes aceita só os tipos com assignableToPerson: true. Os demais
(Locador, Locatário, Fiador, Comprador, Vendedor, Construtora) são derivados do
vínculo real e aparecem sozinhos: você inclui o imóvel com o proprietário e a marca vem.

Conta bancária: chave PIX conferida contra o tipo, depósito
para terceiro exigindo o documento de quem recebe, e no máximo uma conta principal.
Anexo de documento não entra por esta rota.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 2 and 100
string
required
length between 11 and 20
string | null
integer | null
1 to 5
string | null
boolean
boolean
boolean
relationshipTypes
array of strings
length ≤ 30
relationshipTypes
phones
array of objects
length ≤ 20
phones
emails
array of objects
length ≤ 20
emails
addresses
array of objects
length ≤ 10
addresses
bankAccounts
array of objects
length ≤ 10
bankAccounts
documents
array of objects
length ≤ 20
documents
string | null
^\d{4}-\d{2}-\d{2}$
string | null
enum
Allowed:
string | null
enum
Allowed:
string | null
string | null
number | null
≥ 0
number | null
≥ 0
number | null
≥ 0
number | null
≥ 0
boolean | null
string | null
string | null
^\d{4}-\d{2}-\d{2}$
string | null
number | null
≥ 0
integer | null
0 to 9007199254740991
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json