Skip to main content
POST
Enroll a Beneficiary as a recipient sub-user

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
bank_account_id
string

Which of the Beneficiary's bank accounts to register with the provider. Omit to auto-resolve the single payout-usable account; required when the Beneficiary has more than one.

Response

id
string
required
beneficiary_id
string
required
environment
enum<string>
required
Available options:
sandbox,
production
provider
string
required

Logical enrollment provider

Example:

"checkbook"

provider_ref
object | null
required

Provider's canonical handle (Checkbook user id). Read from the provider-account registry that owns it, so null for a rail that registers no handle.

provider_user_id
object | null
required

The provider recipient handle dispatch addresses (Checkbook minted user_id)

status
enum<string>
required
Available options:
pending,
verified,
rejected,
suspended,
closed
provider_state
string
required

Verbatim provider lifecycle token

created_at
string<date-time>
required
status_changed_at
string<date-time>
required
verified_at
object | null
required