/api/v1/end-users/businesses/{id}Update Business End User
Updates an existing business end user with complete business information, related persons (directors, UBOs), and registration details.
Request
curl -X PUT https://publicapi.sandbox.hercle.financial/api/v1/end-users/businesses/{id} \
-H "Authorization: Bearer eyJhb..." \
-H "Content-Type: application/json" \
-d '{"key": "value"}'Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Identifier of the business end user, as returned by GET in id (a UUID); the providerEndUserId value returned by GET (eus_...) is also accepted Example: 3f2b8c1e-7a4d-4e9b-9c61-2d5f8a0b7e43 |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer API_KEY Example: Bearer your_api_key_here |
| Content-Type | string | Yes | application/json Example: application/json |
Request Body
Schema
| Field | Type | Description | Required |
|---|---|---|---|
business | object | Business information of the end user | Yes |
businessPersons | array | List of related persons (e.g. directors, UBOs) for the business. At least one person is required. | Yes |
ipAddress | string | IPv4 address of the business end user: 7-15 characters, digits and dots only e.g. 192.168.1.100 | Yes |
sector | string | Business sector Allowed values: OTHER_PRODUCTS_SERVICESBLOCKCHAINLICENSED_ALCOHOL_SERVICES | Yes |
Business Object
Detailed business information including company registration and address details
| Field | Type | Description | Required |
|---|---|---|---|
companyName | string | Official Company Name (3-140 characters). Can be built of multiple space separated segments. Regex: [a-zA-Z0-9\s',£€¥'':/«»"".?\-+()]+ | Yes |
tradingName | string | Trading name of the business (3-140 characters). Can be built of multiple space separated segments. Regex: [a-zA-Z0-9\s',£€¥'':/«»"".?\-+()]+ | Yes |
type | string | Type of business entity Allowed values: LIMITEDPARTNERSHIPSOLE_TRADER | Yes |
registrationNumber | string | Company registration number (3-140 characters) | Yes |
registrationDate | string | Company registration date in ISO 8601 format: YYYY-MM-DD e.g. 2020-12-31 | Yes |
registeredAddress | object | Registered address of the business | Yes |
tradingAddress | object | Trading address of the business | Yes |
website | string | Company website URL | No |
phone | string | Company phone number | No |
Business Address Object
Physical address information for registered and trading addresses
| Field | Type | Description | Required |
|---|---|---|---|
line1 | string | Primary address line (3-140 characters) | Yes |
line2 | string | Secondary address line (optional, 3-140 characters) | No |
city | string | City (3-140 characters) | Yes |
state | string | State or region (optional, 2-140 characters) | No |
postalCode | string | Postal or ZIP code (3-140 characters) e.g. 67999, 30-555, SW1A 1AA | Yes |
country | string | Country code. The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US | Yes |
Business Person Object
Information about individuals related to the business (directors, UBOs) with ownership details
| Field | Type | Description | Required |
|---|---|---|---|
person | object | Personal details of the related person | Yes |
types | array | Roles of the person in the business e.g ["DIRECTOR", "UBO"] | Yes |
ownership | number | Ownership percentage held by the person, between 0.01 and 100 e.g. 50 | Yes |
Person Object
Personal information for individuals associated with the business
| Field | Type | Description | Required |
|---|---|---|---|
firstName | string | First name (2-140 characters) | Yes |
middleName | string | Middle name (optional, 2-140 characters) | No |
lastName | string | Last name (2-140 characters) | Yes |
dob | string | Date of birth in ISO 8601 format: YYYY-MM-DD e.g. 2020-12-31 | Yes |
birthCountry | string | Country of birth. The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US | No |
nationality | array | Country code of nationality. Array of ISO 3166-1 alpha-2 country codes e.g. ['GB', 'US'] | Yes |
email | string | Email address (5-255 characters) | Yes |
phone | string | Contact phone number | No |
address | object | Residential address of the person | Yes |
identificationDocument | object | Identification document details (optional) | No |
Identification Document Object
Identity verification document information
| Field | Type | Description | Required |
|---|---|---|---|
type | string | Type of identification document Allowed values: PASSPORTDRIVERS_LICENCENATIONAL_IDWORK_PERMIT | Yes |
number | string | Identification document number | Yes |
Example
{
"business": {
"companyName": "Example Corp Ltd",
"tradingName": "Example Trading",
"type": "LIMITED",
"registrationNumber": "12345678",
"registrationDate": "2020-01-15",
"registeredAddress": {
"line1": "123 Business Street",
"line2": "Suite 100",
"city": "London",
"state": "England",
"postalCode": "SW1A 1AA",
"country": "GB"
},
"tradingAddress": {
"line1": "456 Trading Avenue",
"line2": "Floor 5",
"city": "London",
"state": "England",
"postalCode": "SW1A 2BB",
"country": "GB"
},
"website": "https://example.com",
"phone": "+441234567890"
},
"businessPersons": [
{
"person": {
"firstName": "John",
"middleName": "William",
"lastName": "Doe",
"dob": "1985-03-20",
"birthCountry": "GB",
"nationality": [
"GB"
],
"email": "john.doe@example.com",
"phone": "+441234567891",
"address": {
"line1": "789 Residential Road",
"line2": "Apt 10",
"city": "London",
"state": "England",
"postalCode": "SW1A 3CC",
"country": "GB"
},
"identificationDocument": {
"type": "PASSPORT",
"number": "AB123456C"
}
},
"types": [
"DIRECTOR",
"UBO"
],
"ownership": 75
}
],
"ipAddress": "192.168.1.100",
"sector": "OTHER_PRODUCTS_SERVICES"
}Response
Success Response Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the business end user (a UUID; end users migrated from earlier records keep their eus_... reference as id) |
providerEndUserId | string | null | Banking provider reference of the end user. Always null in this response; read it with GET /api/v1/end-users/businesses |
business | object | Complete business information as registered |
businessPersons | array | Array of business persons with full details |
ipAddress | string | Always an empty string: the IP address is not stored for business end users |
registrationStatus | string | Current registration status (e.g., CREATED) |
sector | string | Business sector |
createdAt | number | Unix timestamp of creation (milliseconds) |
updatedAt | number | Unix timestamp of last update (milliseconds); 0 if never updated |
Business End User Response Object
Top-level response containing the updated business end user details
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the business end user (a UUID; end users migrated from earlier records keep their eus_... reference as id) |
providerEndUserId | string | null | Banking provider reference of the end user. Always null in this response; read it with GET /api/v1/end-users/businesses |
business | object | Complete business information as registered |
businessPersons | array | Array of business persons with full details |
ipAddress | string | Always an empty string: the IP address is not stored for business end users |
registrationStatus | string | Current registration status (e.g., CREATED) |
sector | string | Business sector |
createdAt | number | Unix timestamp of creation (milliseconds) |
updatedAt | number | Unix timestamp of last update (milliseconds); 0 if never updated |
Business Object
Detailed business information including company registration and address details
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the business |
companyName | string | Official Company Name. Can be built of multiple space separated segments. Regex: [a-zA-Z0-9\s',£€¥'':/«»"".?\-+()]+ |
tradingName | string | Trading name of the business. Can be built of multiple space separated segments. Regex: [a-zA-Z0-9\s',£€¥'':/«»"".?\-+()]+ |
type | string | Type of business entity Allowed values: LIMITEDPARTNERSHIPSOLE_TRADER |
registrationNumber | string | Company registration number |
registrationDate | string | Company registration date in ISO 8601 format: YYYY-MM-DD e.g. 2020-12-31 |
registeredAddress | object | Registered address of the business |
tradingAddress | object | Trading address of the business |
website | string | Company website URL |
phone | string | Company phone number |
Business Address Object
Physical address information for registered and trading addresses
| Field | Type | Description |
|---|---|---|
line1 | string | Primary address line (3-140 characters) |
line2 | string | Secondary address line (optional, 3-140 characters) |
city | string | City (3-140 characters) |
state | string | State or region (optional, 2-140 characters) |
postalCode | string | Postal or ZIP code (3-140 characters) e.g. 67999, 30-555, SW1A 1AA |
country | string | Country code. The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US |
Business Person Object
Information about individuals related to the business (directors, UBOs) with ownership details
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the business person |
businessEndUserId | string | ID of the business end user this person is associated with |
person | object | Personal details of the related person |
types | array | Roles of the person in the business e.g ["DIRECTOR", "UBO"] |
ownership | number | Ownership percentage held by the person e.g. 75. Stored with single precision, so a value such as 33.33 can come back as 33.33000183105469; round it on your side |
createdAt | number | Unix timestamp of creation (milliseconds). Same value as the end user's createdAt |
updatedAt | number | Unix timestamp of last update (milliseconds). Same value as the end user's updatedAt |
Person Object
Personal information for individuals associated with the business
| Field | Type | Description |
|---|---|---|
firstName | string | First name (2-140 characters) |
middleName | string | Middle name (optional, 2-140 characters) |
lastName | string | Last name (2-140 characters) |
dob | string | Date of birth in ISO 8601 format: YYYY-MM-DD e.g. 2020-12-31 |
birthCountry | string | Country of birth. The two-letter code used to identify a country. ISO 3166-1 alpha-2 country code e.g. GB or US |
nationality | array | Country code of nationality. Array of ISO 3166-1 alpha-2 country codes e.g. ['GB', 'US'] |
email | string | Email address (5-255 characters) |
phone | string | Contact phone number |
address | object | Residential address of the person |
identificationDocument | object | null | Identification document details, or null when not provided |
Identification Document Object
Identity verification document information
| Field | Type | Description |
|---|---|---|
type | string | Type of identification document Allowed values: PASSPORTDRIVERS_LICENCENATIONAL_IDWORK_PERMIT |
number | string | Identification document number |
Responses
Business end user successfully updated
{
"id": "3f2b8c1e-7a4d-4e9b-9c61-2d5f8a0b7e43",
"providerEndUserId": null,
"business": {
"id": "bus_xyz789abc",
"companyName": "Example Corp Ltd",
"tradingName": "Example Trading",
"type": "LIMITED",
"registrationNumber": "12345678",
"registrationDate": "2020-01-15",
"registeredAddress": {
"line1": "123 Business Street",
"line2": "Suite 100",
"city": "London",
"state": "England",
"postalCode": "SW1A 1AA",
"country": "GB"
},
"tradingAddress": {
"line1": "456 Trading Avenue",
"line2": "Floor 5",
"city": "London",
"state": "England",
"postalCode": "SW1A 2BB",
"country": "GB"
},
"website": "https://example.com",
"phone": "+441234567890"
},
"businessPersons": [
{
"id": "bp_xyz789abc123",
"businessEndUserId": "3f2b8c1e-7a4d-4e9b-9c61-2d5f8a0b7e43",
"person": {
"firstName": "John",
"middleName": "William",
"lastName": "Doe",
"dob": "1985-03-20",
"birthCountry": "GB",
"nationality": [
"GB"
],
"email": "john.doe@example.com",
"phone": "+441234567891",
"address": {
"line1": "789 Residential Road",
"line2": "Apt 10",
"city": "London",
"state": "England",
"postalCode": "SW1A 3CC",
"country": "GB"
},
"identificationDocument": {
"type": "PASSPORT",
"number": "AB123456C"
}
},
"types": [
"DIRECTOR",
"UBO"
],
"ownership": 75,
"createdAt": 1704067200000,
"updatedAt": 1704067200000
}
],
"ipAddress": "",
"registrationStatus": "CREATED",
"sector": "OTHER_PRODUCTS_SERVICES",
"createdAt": 1704067200000,
"updatedAt": 1704067200000
}API Tester
Test this endpoint directly against the sandbox environment
Get your API key from Hercle Sandbox
Identifier of the business end user, as returned by GET in id (a UUID); the providerEndUserId value returned by GET (eus_...) is also accepted
https://publicapi.sandbox.hercle.financial/api/v1/end-users/businesses/{id}