/api/v1/end-users/individuals/{id}Update Individual End User
Updates an existing individual end user (natural person) with personal details, identification, and registration information.
Request
curl -X PUT https://publicapi.sandbox.hercle.financial/api/v1/end-users/individuals/{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 individual end user, as returned by GET in id (a UUID); the providerEndUserId value returned by GET (eus_...) is also accepted Example: 550e8400-e29b-41d4-a716-446655440000 |
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 |
|---|---|---|---|
person | object | Personal details of the individual end user | Yes |
ipAddress | string | IP address used when registering the individual end user | Yes |
Person Object
Personal information of the individual end user including name, contact details, address, and identification
| Field | Type | Description | Required |
|---|---|---|---|
firstName | string | First name (1-100 characters) | Yes |
lastName | string | Last name (1-100 characters) | Yes |
middleName | string | Middle name (optional) | No |
dob | string | Date of birth in ISO 8601 format: YYYY-MM-DD e.g. 1990-05-20 | Yes |
nationality | array | Array of nationality codes (ISO 3166-1 alpha-2, e.g., ["IT"]) | Yes |
birthCountry | string | Country of birth. ISO 3166-1 alpha-2 country code e.g. IT (optional) | No |
phone | string | Contact phone number in E.164 format e.g. +393331234567 | Yes |
email | string | Email address | Yes |
address | object | Residential address of the person | Yes |
identificationDocument | object | Identification document details | Yes |
Address Object
Residential address of the individual
| Field | Type | Description | Required |
|---|---|---|---|
line1 | string | Primary address line (3-140 characters) | Yes |
line2 | string | Secondary address line (optional) | No |
city | string | City | Yes |
state | string | State or province (optional) | No |
postalCode | string | Postal or ZIP code | Yes |
country | string | Country code. ISO 3166-1 alpha-2 country code e.g. GB or US | Yes |
Identification Document Object
Identity verification document information
| Field | Type | Description | Required |
|---|---|---|---|
type | string | Type of identification document Allowed values: PASSPORTNATIONAL_IDDRIVERS_LICENCEWORK_PERMIT | Yes |
number | string | Identification document number | Yes |
Example
{
"person": {
"firstName": "Mario",
"lastName": "Rossi",
"dob": "1990-05-20",
"nationality": [
"IT"
],
"birthCountry": "IT",
"phone": "+393331234567",
"email": "mario.rossi@example.com",
"address": {
"line1": "Via Roma 10",
"city": "Milano",
"postalCode": "20100",
"country": "IT",
"state": "MI"
},
"identificationDocument": {
"number": "AX1234567",
"type": "PASSPORT"
}
},
"ipAddress": "192.168.1.1"
}Response
Success Response Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the individual 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/individuals |
person | object | Personal details as registered |
registrationStatus | string | Registration status reported by the banking provider, e.g. ACTIVE, IN_REVIEW, SUSPENDED, REJECTED or CLOSED. The previous status is kept when the provider reports none |
createdAt | number | Unix timestamp of creation (milliseconds) |
updatedAt | number | Unix timestamp of last update (milliseconds); 0 if never updated |
Individual End User Response Object
Top-level response containing the updated individual end user details
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the individual 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/individuals |
person | object | Personal details as registered |
registrationStatus | string | Registration status reported by the banking provider, e.g. ACTIVE, IN_REVIEW, SUSPENDED, REJECTED or CLOSED. The previous status is kept when the provider reports none |
createdAt | number | Unix timestamp of creation (milliseconds) |
updatedAt | number | Unix timestamp of last update (milliseconds); 0 if never updated |
Person Object
Personal information as registered. Every key is always present; values that were not sent come back as empty strings
| Field | Type | Description |
|---|---|---|
firstName | string | First name |
middleName | string | Middle name, or an empty string |
lastName | string | Last name |
email | string | Email address |
phone | string | Contact phone number |
dob | string | Date of birth (YYYY-MM-DD) |
birthCountry | string | Country of birth (ISO 3166-1 alpha-2), or an empty string |
nationality | array | Array of nationality codes (ISO 3166-1 alpha-2, e.g., ["IT"]) |
address | object | Residential address (see Address Object) |
identificationDocument | object | Identification document details (see Identification Document Object), as sent in the request |
Address Object
Residential address information
| Field | Type | Description |
|---|---|---|
line1 | string | Primary address line |
line2 | string | Secondary address line, or an empty string |
city | string | City |
state | string | State or province, or an empty string |
postalCode | string | Postal or ZIP code |
country | string | Country code (ISO 3166-1 alpha-2, e.g., IT) |
Identification Document Object
Identity verification document information
| Field | Type | Description |
|---|---|---|
type | string | Document type: PASSPORT, NATIONAL_ID, DRIVERS_LICENCE or WORK_PERMIT |
number | string | Document number |
Responses
Individual end user successfully updated
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"providerEndUserId": null,
"person": {
"firstName": "Mario",
"middleName": "",
"lastName": "Rossi",
"email": "mario.rossi@example.com",
"phone": "+393331234567",
"dob": "1990-05-20",
"birthCountry": "IT",
"nationality": [
"IT"
],
"address": {
"line1": "Via Roma 10",
"line2": "",
"city": "Milano",
"state": "MI",
"postalCode": "20100",
"country": "IT"
},
"identificationDocument": {
"number": "AX1234567",
"type": "PASSPORT"
}
},
"registrationStatus": "ACTIVE",
"createdAt": 1678886400000,
"updatedAt": 1678886400000
}API Tester
Test this endpoint directly against the sandbox environment
Get your API key from Hercle Sandbox
Identifier of the individual 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/individuals/{id}