Saltar al contenido principal
Obtener detalles de un titular
curl --request GET \
  --url http://127.0.0.1:4003/v1/holders/{id} \
  --header 'X-Lerian-Id: <x-lerian-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
}

Headers

Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el plugin Access Manager.

X-Organization-Id
string
required

Identificador único de la organización asociada a la solicitud.

X-Lerian-Id
string
required

Identificador único del cliente de Lerian, generado y asignado por Lerian.

Path Parameters

id
string
required

Identificador único del titular.

Query Parameters

include_deleted
string

Si es true, también se incluirán los titulares eliminados lógicamente (soft delete).

Response

OK

Detalles del titular.

id
string

Identificador único del titular.

externalId
string

Campo opcional para vincular este titular a un sistema externo.

type
enum<string>

Define si el titular es una persona física o una empresa.

  • NATURAL_PERSON – Persona física
  • LEGAL_PERSON – Empresa
Opciones disponibles:
NATURAL_PERSON,
LEGAL_PERSON
name
string

Nombre completo del titular.

document
string

Número de identificación del titular (por ejemplo, CPF o CNPJ).

addresses
object

Información de direcciones del titular.

contact
object

Información de contacto del titular.

naturalPerson
object

Información específica de personas físicas.

Información específica de personas jurídicas.

metadata
object

Objeto que contiene pares clave-valor para agregar como metadata, donde el nombre del campo es la clave y el valor es el valor.

createdAt
string

Fecha en que se creó el titular.

deletedAt
string

Fecha en que el titular fue eliminado.

updatedAt
string

Fecha de la última actualización del titular.