Buscar pessoa

curl --request GET \
  --url https://api.juridiq.com.br/person/{id} \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/person/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

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

{
  "id": "<string>",
  "name": "<string>",
  "personOrigin": "<string>",
  "officeId": "<string>",
  "isLinkedToJurichat": true,
  "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",
  "customFields": [
    {
      "fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "options": [
        "<string>"
      ],
      "value": "<string>",
      "isArchived": true
    }
  ]
}

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

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

GET

person

{id}

Buscar pessoa

curl --request GET \
  --url https://api.juridiq.com.br/person/{id} \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/person/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

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

{
  "id": "<string>",
  "name": "<string>",
  "personOrigin": "<string>",
  "officeId": "<string>",
  "isLinkedToJurichat": true,
  "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",
  "customFields": [
    {
      "fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "options": [
        "<string>"
      ],
      "value": "<string>",
      "isArchived": true
    }
  ]
}

{
  "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. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Path Parameters

string<uuid>

required

ID da pessoa

Response

Default Response

string

required

ID da pessoa

name

string

required

Nome

personOrigin

string

required

Origem. Ex: cliente, parte

officeId

string

required

ID do escritório

isLinkedToJurichat

boolean

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

string | null

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

Data de criação

updatedAt

Data da última alteração

customFields

object[]

Valores dos campos personalizados do escritório

Show child attributes

Primeiros Passos

API Reference

Buscar pessoa

Authorizations

Path Parameters

Response