Criar pessoa

POST /person/

Criar pessoa

cURL

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": "[e-mail]",
  "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>",
  "consultingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "consultingColumnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createAnyWay": true
}
'

import requests

url = "https://api.juridiq.com.br/person/"

payload = {
    "name": "<string>",
    "personOrigin": "<string>",
    "email": "[e-mail]",
    "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>",
    "consultingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "consultingColumnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createAnyWay": True
}
headers = {
    "x-juridiq-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    personOrigin: '<string>',
    email: '[e-mail]',
    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>',
    consultingId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    consultingColumnId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    createAnyWay: true
  })
};

fetch('https://api.juridiq.com.br/person/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/person/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'personOrigin' => '<string>',
    'email' => '[e-mail]',
    '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>',
    'consultingId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'consultingColumnId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'createAnyWay' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/person/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"personOrigin\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"imageUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"maritalStatus\": \"<string>\",\n  \"zipCode\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"neighborhood\": \"<string>\",\n  \"streetAndNumber\": \"<string>\",\n  \"clientDiscoverOffice\": \"<string>\",\n  \"annotation\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rg\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"profession\": \"<string>\",\n  \"birthDate\": \"<string>\",\n  \"isPrivate\": true,\n  \"legalRepresentant\": \"<string>\",\n  \"tags\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"corretor\": \"<string>\",\n  \"code\": \"<string>\",\n  \"govPassword\": \"<string>\",\n  \"addressComplement\": \"<string>\",\n  \"consultingId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"consultingColumnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createAnyWay\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juridiq-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/person/")
  .header("x-juridiq-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"personOrigin\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"imageUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"maritalStatus\": \"<string>\",\n  \"zipCode\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"neighborhood\": \"<string>\",\n  \"streetAndNumber\": \"<string>\",\n  \"clientDiscoverOffice\": \"<string>\",\n  \"annotation\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rg\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"profession\": \"<string>\",\n  \"birthDate\": \"<string>\",\n  \"isPrivate\": true,\n  \"legalRepresentant\": \"<string>\",\n  \"tags\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"corretor\": \"<string>\",\n  \"code\": \"<string>\",\n  \"govPassword\": \"<string>\",\n  \"addressComplement\": \"<string>\",\n  \"consultingId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"consultingColumnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createAnyWay\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/person/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"personOrigin\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"imageUrl\": \"<string>\",\n  \"document\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"personType\": \"<string>\",\n  \"maritalStatus\": \"<string>\",\n  \"zipCode\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"neighborhood\": \"<string>\",\n  \"streetAndNumber\": \"<string>\",\n  \"clientDiscoverOffice\": \"<string>\",\n  \"annotation\": \"<string>\",\n  \"officeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"rg\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"profession\": \"<string>\",\n  \"birthDate\": \"<string>\",\n  \"isPrivate\": true,\n  \"legalRepresentant\": \"<string>\",\n  \"tags\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"corretor\": \"<string>\",\n  \"code\": \"<string>\",\n  \"govPassword\": \"<string>\",\n  \"addressComplement\": \"<string>\",\n  \"consultingId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"consultingColumnId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createAnyWay\": true\n}"

response = http.request(request)
puts response.read_body

201

{
  "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"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

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

legalRepresentant · string

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

consultingId · string<uuid>

ID da consultoria em atendimento atual

consultingColumnId · string<uuid>

ID da coluna do CRM para onde mover a consultoria selecionada

createAnyWay · boolean

Ignora validação de nome semelhante e cria a pessoa mesmo assim

Response

201

application/json

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

legalRepresentant · string | null

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 · string<date-time> string

Data de criação

updatedAt · string<date-time> string

Data da última alteração