---
title: "Invite Client"
method: POST
path: "/api/adviser/clients/invite"
tags: ["Adviser"]
---

# Invite Client

`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

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.

## Request body

- AppApiAdviserInviteRequest
  - `client_label` string, required
  - `client_email` string, email, required
  - `scope` 'category_totals' | 'full_transactions': What an active grant lets the firm's advisers read.
  - `can_recategorise` boolean

## Response `201`

Successful Response

- AppApiAdviserInviteResponse
  - `grant_id` string, required
  - `invite_token` string, required
  - `invite_expires_at` string, date-time, required
  - `status` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)