Hercle
REST
DELETE/api/v1/end-users/relations

Delete End User Relation

Deletes the relation with an end user (individual or business).

Auth:Bearer <api_key>
Tags:Banking

Request

cURL
curl -X DELETE https://publicapi.sandbox.hercle.financial/api/v1/end-users/relations \
  -H "Authorization: Bearer eyJhb..." \
  -H "Content-Type: application/json" \
  -d '{"id": "addr_1234567890"}'

Headers

NameTypeRequiredDescription
AuthorizationstringYesBearer API_KEY
Example: Bearer your_api_key_here
Content-TypestringYesapplication/json
Example: application/json

Request Body

Schema

FieldTypeDescriptionRequired
endUserIdstringIdentifier of the end user, as returned by GET in id (a UUID); the providerEndUserId value returned by GET (eus_...) is also acceptedYes
endUserTypestring
Type of end user
Allowed values:
Individual
Business
Yes

Example

{
  "endUserId": "550e8400-e29b-41d4-a716-446655440000",
  "endUserType": "Individual"
}

Response

Success Response Schema

FieldTypeDescription
endUserIdstringIdentifier of the end user, as sent in the request
endUserTypestringType of end user (individual or business)
deletedAtstringISO 8601 UTC timestamp of when the relation was deleted, with 7 fractional digits, e.g. 2026-04-02T12:00:00.1234567Z

Delete End User Relation Response Object

Response containing the deleted end user relation details

FieldTypeDescription
endUserIdstringIdentifier of the end user, as sent in the request
endUserTypestringType of end user (individual or business)
deletedAtstringISO 8601 UTC timestamp of when the relation was deleted, with 7 fractional digits, e.g. 2026-04-02T12:00:00.1234567Z

Responses

End user relation successfully deleted

200 application/json
{
  "endUserId": "550e8400-e29b-41d4-a716-446655440000",
  "endUserType": "individual",
  "deletedAt": "2026-04-02T12:00:00.1234567Z"
}

API Tester

Test this endpoint directly against the sandbox environment

Get your API key from Hercle Sandbox

https://publicapi.sandbox.hercle.financial/api/v1/end-users/relations