Buscar pessoa por telefone

GET /person/search

Buscar pessoa por telefone

cURL

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

import requests

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

headers = {"x-juridiq-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.juridiq.com.br/person/search', 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/search",
  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/search"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.juridiq.com.br/person/search")
  .header("x-juridiq-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "personOrigin": "<string>",
  "isPrivate": true,
  "ownerId": "<string>",
  "legalRepresentant": "<string>",
  "corretor": "<string>",
  "code": "<string>",
  "govPassword": "<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.

Query Parameters

phoneNumber · string · required

Telefone para busca

Minimum string length: 1

Response

200

application/json

Default Response

id · string · required

ID da pessoa

name · string · required

Nome

email · string | null

E-mail

phone · string | null

Telefone

personOrigin · string | null

Origem. Ex: cliente, parte

isPrivate · boolean

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