Consent
Withdraw an Entity's Consent
POST
/
entities
/
{ent_id}
/
consent
Withdraws an Entity’s consent. This endpoint sets the entity’s status to disabled
, withdraws consent on all the entity’s accounts,
and removes all active Products or Subscriptions across all the Entity’s accounts.
Path Parameters
ent_id
string
requiredID of the Entity.
Body
type
enum
requiredAvailable types: withdraw
.
reason
string
requiredAvailable Reasons: entity_withdrew_consent
.
Returns
Returns the entity with status
set to disabled
.