Adviser

Invite Client

Create a PENDING consent grant + invite token.

The grant only becomes ACTIVE when the client accepts it via POST /api/consents/{id}/accept. Email delivery is out of scope — the token is returned to the adviser.

post/api/adviser/clients/invite

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/adviser/clients/invite
  • Auth: HTTP bearer

Request body

client_labelstring required
client_emailstring email required
scope'category_totals' | 'full_transactions'

What an active grant lets the firm's advisers read.

can_recategoriseboolean

Response

Successful Response

grant_idstring required
invite_tokenstring required
invite_expires_atstring date-time required
statusstring required

Changes

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