curl --request PATCH \
--url http://127.0.0.1:4003/v1/holders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Lerian-Id: <x-lerian-id>' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
"name": "ACME Corp LTD",
"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": "[email protected]",
"secondaryEmail": "[email protected]",
"mobilePhone": "5577927967227",
"otherPhone": "556829443019"
},
"naturalPerson": {
"favoriteName": "Timothy Bode",
"socialName": "Dr. Ervin Keebler",
"gender": "male",
"birthDate": "1990-10-12",
"civilStatus": "Married",
"nationality": "Brazilian",
"motherName": "Hector Jaskolski",
"fatherName": "Ms. Carolyn Weber",
"status": "Active"
},
"legalPerson": {
"activity": "Electronic devices development",
"foundingDate": "2025-01-01",
"representative": {
"document": "91315026015",
"email": "[email protected]",
"name": "John Doe",
"role": "CFO"
},
"size": "Medium",
"status": "Closed",
"tradeName": "Lerian Studio",
"type": "Limited Liability"
},
"metadata": {
"metadata1": "value1",
"metadata2": 2
}
}
'{
"id": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
"externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
"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": "[email protected]",
"secondaryEmail": "[email protected]",
"mobilePhone": "5577927967227",
"otherPhone": "556829443019"
},
"naturalPerson": {
"favoriteName": "Timothy Bode",
"socialName": "Dr. Ervin Keebler",
"gender": "male",
"birthDate": "1990-10-12",
"civilStatus": "Married",
"nationality": "Brazilian",
"motherName": "Hector Jaskolski",
"fatherName": "Ms. Carolyn Weber",
"status": "Active"
},
"legalPerson": {
"activity": "Electronic devices development",
"foundingDate": "2025-01-01",
"representative": {
"document": "91315026015",
"email": "[email protected]",
"name": "John Doe",
"role": "CFO"
},
"size": "Medium",
"status": "Closed",
"tradeName": "Lerian Studio",
"type": "Limited Liability"
},
"metadata": {
"metadata1": "value1",
"metadata2": 2
},
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:00Z",
"deletedAt": null
}Update a Holder
Use this endpoint to update the details of a Holder.
curl --request PATCH \
--url http://127.0.0.1:4003/v1/holders/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Lerian-Id: <x-lerian-id>' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
"name": "ACME Corp LTD",
"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": "[email protected]",
"secondaryEmail": "[email protected]",
"mobilePhone": "5577927967227",
"otherPhone": "556829443019"
},
"naturalPerson": {
"favoriteName": "Timothy Bode",
"socialName": "Dr. Ervin Keebler",
"gender": "male",
"birthDate": "1990-10-12",
"civilStatus": "Married",
"nationality": "Brazilian",
"motherName": "Hector Jaskolski",
"fatherName": "Ms. Carolyn Weber",
"status": "Active"
},
"legalPerson": {
"activity": "Electronic devices development",
"foundingDate": "2025-01-01",
"representative": {
"document": "91315026015",
"email": "[email protected]",
"name": "John Doe",
"role": "CFO"
},
"size": "Medium",
"status": "Closed",
"tradeName": "Lerian Studio",
"type": "Limited Liability"
},
"metadata": {
"metadata1": "value1",
"metadata2": 2
}
}
'{
"id": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
"externalId": "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42",
"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": "[email protected]",
"secondaryEmail": "[email protected]",
"mobilePhone": "5577927967227",
"otherPhone": "556829443019"
},
"naturalPerson": {
"favoriteName": "Timothy Bode",
"socialName": "Dr. Ervin Keebler",
"gender": "male",
"birthDate": "1990-10-12",
"civilStatus": "Married",
"nationality": "Brazilian",
"motherName": "Hector Jaskolski",
"fatherName": "Ms. Carolyn Weber",
"status": "Active"
},
"legalPerson": {
"activity": "Electronic devices development",
"foundingDate": "2025-01-01",
"representative": {
"document": "91315026015",
"email": "[email protected]",
"name": "John Doe",
"role": "CFO"
},
"size": "Medium",
"status": "Closed",
"tradeName": "Lerian Studio",
"type": "Limited Liability"
},
"metadata": {
"metadata1": "value1",
"metadata2": 2
},
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:00Z",
"deletedAt": null
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The authorization token. This header is required if your environment has the Access Manager plugin enabled.
The unique identifier of the Organization associated with the request.
The unique identifier of Lerian's client, generated and assigned by Lerian.
Path Parameters
Unique identifier of the Holder you want to update.
Body
User's details that will be updated.
Optional field for linking this Holder to an external system.
Full name of the Holder. Note: Use the legal name for companies (Legal Person). For individuals (Natural Person), use their full name.
Holder's address information.
Show child attributes
Show child attributes
Details about the primary address.
Show child attributes
Show child attributes
Street name and building number.
Extra address details, for example, apartment or suite number.
Postal or ZIP code.
City where the address is located.
State, province, or region.
Two-letter country code (ISO 3166-1 alpha-2).
A label to help identify this address.
Details about the first additional address.
Show child attributes
Show child attributes
Street name and building number.
Extra address details, for example, apartment or suite number.
Postal or ZIP code.
City where the address is located.
State, province, or region.
Two-letter country code (ISO 3166-1 alpha-2).
A label to help identify this address.
Details about the second additional address.
Show child attributes
Show child attributes
Street name and building number.
Extra address details, for example, apartment or suite number.
Postal or ZIP code.
City where the address is located.
State, province, or region.
Two-letter country code (ISO 3166-1 alpha-2).
A label to help identify this address.
Holder’s contact information.
Show child attributes
Show child attributes
The primary email used to contact the holder.
The secondary email used to contact the holder.
The mobile phone number used to contact the holder, including country code.
Any additional phone number used to contact the holder.
Information specific to individuals.
Show child attributes
Show child attributes
Nickname or preferred name.
Social name, if different from the legal name.
Gender identity of the person.
Date of birth in YYYY-MM-DD format.
Civil status — for example: Single, Married, or Divorced.
Nationality, for example, Brazilian.
Mother’s full name.
Father’s full name.
Current status of the individual in the system.
Information specific to legal entities.
Show child attributes
Show child attributes
The type of business or activity the company engages in.
The date when the company was established.
Details of the company's legal representative.
Show child attributes
Show child attributes
The document number of the legal representative.
The email address of the legal representative.
The legal representative’s name.
The role of the legal representative within the company.
The size classification of the company.
The current status of the company.
The registered business name of the company, if applicable.
The legal structure of the company.
Response
OK
Holder's details.
Unique identifier of the Holder.
Optional field for linking this Holder to an external system.
Defines if the Holder is an individual or a company.
NATURAL_PERSON– IndividualLEGAL_PERSON– Company
NATURAL_PERSON, LEGAL_PERSON Full name of the Holder.
Holder's identification number (such as CPF or CNPJ).
Holder's address information.
Show child attributes
Show child attributes
Details about the primary address.
Show child attributes
Show child attributes
Street name and building number.
Extra address details, for example, apartment or suite number.
Postal or ZIP code.
City where the address is located.
State, province, or region.
Two-letter country code (ISO 3166-1 alpha-2).
A label to help identify this address.
Details about the first additional address.
Show child attributes
Show child attributes
Street name and building number.
Extra address details, for example, apartment or suite number.
Postal or ZIP code.
City where the address is located.
State, province, or region.
Two-letter country code (ISO 3166-1 alpha-2).
A label to help identify this address.
Details about the second additional address.
Show child attributes
Show child attributes
Street name and building number.
Extra address details, for example, apartment or suite number.
Postal or ZIP code.
City where the address is located.
State, province, or region.
Two-letter country code (ISO 3166-1 alpha-2).
A label to help identify this address.
Holder’s contact information.
Show child attributes
Show child attributes
The primary email used to contact the holder.
The secondary email used to contact the holder.
The mobile phone number used to contact the holder, including country code.
Any additional phone number used to contact the holder.
Information specific to individuals.
Show child attributes
Show child attributes
Nickname or preferred name.
Social name, if different from the legal name.
Gender identity of the person.
Date of birth in YYYY-MM-DD format.
Civil status — for example: Single, Married, or Divorced.
Nationality, for example, Brazilian.
Mother’s full name.
Father’s full name.
Current status of the individual in the system.
Information specific to legal entities.
Show child attributes
Show child attributes
The type of business or activity the company engages in.
The date when the company was established.
Details of the company's legal representative.
Show child attributes
Show child attributes
The document number of the legal representative.
The email address of the legal representative.
The legal representative’s name.
The role of the legal representative within the company.
The size classification of the company.
The current status of the company.
The registered business name of the company, if applicable.
The legal structure of the company.
Date when the Holder was created.
Date when the Holder was deleted.
Date when the Holder was last updated.