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

200

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