Skip to main content
POST
/
person
Criar pessoa
curl --request POST \
  --url https://api.juridiq.com.br/person/ \
  --header 'Content-Type: application/json' \
  --header 'x-juridiq-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "personOrigin": "<string>",
  "email": "jsmith@example.com",
  "imageUrl": "<string>",
  "document": "<string>",
  "phone": "<string>",
  "personType": "<string>",
  "maritalStatus": "<string>",
  "zipCode": "<string>",
  "state": "<string>",
  "city": "<string>",
  "neighborhood": "<string>",
  "streetAndNumber": "<string>",
  "clientDiscoverOffice": "<string>",
  "annotation": "<string>",
  "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rg": "<string>",
  "nationality": "<string>",
  "profession": "<string>",
  "birthDate": "<string>",
  "isPrivate": true,
  "legalRepresentant": "<string>",
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "corretor": "<string>",
  "code": "<string>",
  "govPassword": "<string>",
  "addressComplement": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "personOrigin": "<string>",
  "officeId": "<string>",
  "email": "<string>",
  "document": "<string>",
  "phone": "<string>",
  "personType": "<string>",
  "maritalStatus": "<string>",
  "zipCode": "<string>",
  "state": "<string>",
  "city": "<string>",
  "neighborhood": "<string>",
  "streetAndNumber": "<string>",
  "imageUrl": "<string>",
  "clientDiscoverOffice": "<string>",
  "annotation": "<unknown>",
  "rg": "<string>",
  "nationality": "<string>",
  "profession": "<string>",
  "birthDate": "<string>",
  "isPrivate": true,
  "ownerId": "<string>",
  "legalRepresentant": "<string>",
  "corretor": "<string>",
  "code": "<string>",
  "govPassword": "<string>",
  "addressComplement": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-juridiq-api-key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key.

Body

application/json
name
string
required

Nome

personOrigin
string
required

Origem. Ex: cliente, parte

Minimum string length: 1
email
string<email>

E-mail

imageUrl
string

URL da foto

document
string

CPF ou CNPJ

phone
string

Telefone

personType
string

Tipo. Ex: física, jurídica

maritalStatus
string

Estado civil

zipCode
string

CEP

state
string

Estado

city
string

Cidade

neighborhood
string

Bairro

streetAndNumber
string

Rua e número

clientDiscoverOffice
string

Como conheceu o escritório

annotation
string

Anotação em texto

officeId
string<uuid>

ID do escritório

rg
string

RG

nationality
string

Nacionalidade

profession
string

Profissão

birthDate
string

Data de nascimento

isPrivate
boolean

Registro privado

Representante legal

tags
string<uuid>[]

IDs das tags

corretor
string

Corretor

code
string

Código interno

govPassword
string

Senha gov.br

addressComplement
string

Complemento do endereço

Response

Default Response

id
string
required

ID da pessoa

name
string
required

Nome

personOrigin
string
required

Origem. Ex: cliente, parte

officeId
string
required

ID do escritório

email
string | null

E-mail

document
string | null

CPF ou CNPJ

phone
string | null

Telefone

personType
string | null

Tipo. Ex: física, jurídica

maritalStatus
string | null

Estado civil

zipCode
string | null

CEP

state
string | null

Estado

city
string | null

Cidade

neighborhood
string | null

Bairro

streetAndNumber
string | null

Rua e número

imageUrl
string | null

URL da foto

clientDiscoverOffice
string | null

Como conheceu o escritório

annotation
any

Anotações

rg
string | null

RG

nationality
string | null

Nacionalidade

profession
string | null

Profissão

birthDate
string | null

Data de nascimento

isPrivate
boolean | null

Registro privado

ownerId
string | null

ID do responsável

Representante legal

corretor
string | null

Corretor

code
string | null

Código interno

govPassword
string | null

Senha gov.br

addressComplement
string | null

Complemento do endereço

createdAt

Data de criação

updatedAt

Data da última alteração