Invite Beneficiaries to submit details

Batch-capable (1..N). Mints a scoped collection token per Beneficiary, advances each to invited, and enqueues a tokenized email to a Cleff-hosted form on the collect surface. A resend invalidates the prior link. The dashboard single-invite action is N=1 through this endpoint.

POST /v1/beneficiaries/collection-invites

Invite Beneficiaries to submit their details

cURL

curl --request POST \
  --url https://api.example.com/v1/beneficiaries/collection-invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiary_ids": [
    "<string>"
  ],
  "message": "<string>",
  "display_name": "<string>"
}
'

202

{
  "invited": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Body

application/json

beneficiary_ids · string[] · required

Beneficiary ids to invite (1..N).

scope · enum<string>

How much of onboarding the link collects. Defaults to full_onboarding.

Available options: full_onboarding, bank_details, tax_documents

message · string

Optional free-text note from the sender, included in the invite email.

Maximum string length: 1000

display_name · string

Optional 'name to show on the request': the name the recipient sees on the collect surface and invite email. When omitted, falls back to the inviting Business's display_name, then its legal_name. Same value for every beneficiary in the batch.

Maximum string length: 200

Response

202

application/json

invited · string[] · required

Beneficiary ids that were invited.