LElead
Compliance

Delete account entity relationship

Changed on

Deletes a specific entity relationship from an account and returns the updated list of entity relationships. The relationship_type must be specified to identify which relationship to delete.

delete/v0/accounts/{id}/entity_relationships/{entity_id}

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v0/accounts/{id}/entity_relationships/{entity_id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the Account object.

Example:account_xyz123

Account ID

entity_idstring required

The ID of your entity.

Example:entity_xyz123

Entity ID to remove from the account relationships

Query parameters

relationship_type'account_holder' | 'authorized_signer' | 'authorized_user' required

Indicates the type of Entity

Example:account_holder

The specific relationship type to delete for the entity.

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests. The key doesn't include relationship_type, so use a new key for each relationship you remove.

Response

Entity relationship deleted successfully. Returns the updated list of entity relationships for the account.

Example response

{
  "objects": [
    {
      "entity_id": "entity_xyz123",
      "relationship_type": "account_holder"
    }
  ]
}

Changes