Pular para o conteúdo principal
GET
/
v1
/
holders
/
{holder_id}
Consultar um Titular
curl --request GET \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id} \
  --header 'X-Organization-id: <x-organization-id>'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f",
  "type": "LEGAL_PERSON",
  "name": "ACME Corp LTD",
  "document": "91315026015",
  "addresses": {
    "primary": {
      "line1": "Rua Botucatu 10",
      "line2": "Casa B",
      "zipCode": "04023060",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "description": "BR address"
    },
    "additional1": {
      "line1": "75020 Odell Grove",
      "line2": "Apt. 181",
      "zipCode": "40969-4460",
      "city": "Rubenport",
      "state": "NH",
      "country": "US",
      "description": "US address"
    },
    "additional2": {
      "line1": "52 Lavender Hill",
      "line2": "Apt. 2",
      "zipCode": "SW11 5RH",
      "city": "Battersea",
      "state": "London",
      "country": "UK",
      "description": "UK address"
    }
  },
  "contact": {
    "primaryEmail": "john_doe@email.com",
    "secondaryEmail": "john.doe@workemail.com",
    "mobilePhone": "5577927967227",
    "otherPhone": "556829443019"
  },
  "naturalPerson": {
    "favoriteName": "Johnny",
    "socialName": "Johnny Doe",
    "gender": "Male",
    "birthDate": "1990-12-01",
    "civilStatus": "Married",
    "nationality": "Brazilian",
    "motherName": "Jane Doe",
    "fatherName": "Richard Doe",
    "status": "Active"
  },
  "legalPerson": {
    "tradeName": "ACME",
    "activity": "Electronic devices development",
    "type": "Limited Liability",
    "foundingDate": "2010-01-01",
    "size": "Medium",
    "status": "Closed",
    "representative": {
      "name": "Jane Doe",
      "document": "98765432100",
      "email": "janedoe@corporate.com",
      "role": "CFO"
    }
  },
  "metadata": {
    "metadata1": "value1",
    "metadata2": 2
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "deletedAt": "2025-01-01T00:00:00Z",
  "updatedAt": null
}

Cabeçalhos

​
Authorization
string

O token de autorização no formato 'Bearer '.
Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
X-Organization-id
string
obrigatório

O identificador único da Organização associada à requisição.

Exemplo:

"01946120-0f45-7c5f-86a0-0ea7c59fdbd4"

Parâmetros de caminho

​
holder_id
string
obrigatório

Identificador único do Titular.

Parâmetros de consulta

​
include_deleted
string

Se true, os Titulares que foram excluídos logicamente (soft delete) também serão incluídos.

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

Detalhes do Titular.

​
id
string

Identificador único do Titular.

​
externalId
string

Campo opcional para vincular este Titular a um sistema externo.

​
type
enum<string>

Define se o Titular é uma pessoa física ou uma empresa.

  • NATURAL_PERSON – Pessoa Física
  • LEGAL_PERSON – Pessoa Jurídica
Opções disponíveis:
NATURAL_PERSON,
LEGAL_PERSON
​
name
string

Nome completo do Titular.

​
document
string

Número de identificação do Titular (como CPF ou CNPJ).

​
addresses
object

Informações de endereço do Titular.

​
contact
object

Informações de contato do Titular.

​
naturalPerson
object

Informações específicas de pessoas físicas.

​
legalPerson
object

Informações específicas de entidades jurídicas.

​
metadata
object

Um objeto contendo pares chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

​
createdAt
string

Data em que o Titular foi criado.

​
deletedAt
string

Data em que o Titular foi excluído.

​
updatedAt
string

Data em que o Titular foi atualizado pela última vez.