Consents

Update Consent Scopes

Grant or withdraw the optional scopes on MY grant, independently of the spending scope: balances_and_assets and income_and_payday.

Client-only, active grants only: the scope can never be switched on by an adviser, an invite, or acceptance of an unrelated grant — this endpoint is the sole way it turns on. Withdrawing takes effect at the adviser's next request.

post/api/consents/{grant_id}/scopes

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/consents/{grant_id}/scopes
  • Auth: HTTP bearer

Path parameters

grant_idstring uuid required

Request body

balances_and_assetsboolean nullable
income_and_paydayboolean nullable

Response

Successful Response

idstring required
statusstring required
scopesstring[] required
coversstring[] required

Changes

No recorded changes to this operation across all 2 revisions of this API.