Saltar al contenido principal
POST
/
v1
/
holders
Crear un titular
curl --request POST \
  --url https://crm.sandbox.lerian.net/v1/holders \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-id: <x-organization-id>' \
  --data '{
  "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": "Dirección brasileña"
    },
    "additional1": {
      "line1": "75020 Odell Grove",
      "line2": "Apt. 181",
      "zipCode": "40969-4460",
      "city": "Rubenport",
      "state": "NH",
      "country": "US",
      "description": "Dirección estadounidense"
    },
    "additional2": {
      "line1": "52 Lavender Hill",
      "line2": "Apt. 2",
      "zipCode": "SW11 5RH",
      "city": "Battersea",
      "state": "London",
      "country": "UK",
      "description": "Dirección británica"
    }
  },
  "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": "Casado",
    "nationality": "Brasileño",
    "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
  }
}'
{
"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": "Dirección brasileña"
},
"additional1": {
"line1": "75020 Odell Grove",
"line2": "Apt. 181",
"zipCode": "40969-4460",
"city": "Rubenport",
"state": "NH",
"country": "US",
"description": "Dirección estadounidense"
},
"additional2": {
"line1": "52 Lavender Hill",
"line2": "Apt. 2",
"zipCode": "SW11 5RH",
"city": "Battersea",
"state": "London",
"country": "UK",
"description": "Dirección británica"
}
},
"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": "Casado",
"nationality": "Brasileño",
"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": "2025-01-01T00:00:00Z"
}

Headers

Authorization
string

El token de autorización en formato 'Bearer <token>'.
Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

X-Organization-id
string
required

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

Example:

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

X-Lerian-Id
string

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

Example:

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

Body

application/json

Información sobre el nuevo titular.

type
enum<string>
required

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
required

Nombre completo del titular.

Nota: utiliza la razón social para las empresas (persona jurídica). Para las personas físicas, usa su nombre completo.

document
string
required

Número de identificación del titular (como CPF o CNPJ).

externalId
string

Campo opcional para vincular este titular con un sistema externo.

addresses
object

Información de la dirección del titular.

contact
object

Información de contacto del titular.

naturalPerson
object

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

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

metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para añadir un centro de costos, usa costCenter: BR_11101997.

Response

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

Detalles del titular.

id
string

Identificador único del titular.

externalId
string

Campo opcional para vincular este titular con 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 (como CPF o CNPJ).

addresses
object

Información de la dirección del titular.

contact
object

Información de contacto del titular.

naturalPerson
object

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

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

metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para añadir un centro de costos, usa costCenter: BR_11101997.

createdAt
string

Fecha en que se creó el titular.

deletedAt
string

Fecha en que se eliminó el titular.

updatedAt
string

Fecha de la última actualización del titular.