Enroll a Beneficiary with the provider
Registers the Beneficiary as a Checkbook marketplace sub-user (create → KYC → verify → register default bank) so payouts reach them with zero rail-originated emails. The default bank is decrypted and registered at enrollment time. Idempotent per (beneficiary, environment, provider) — re-enrolling returns the existing record, never a second sub-user. Provider credentials are encrypted at rest and never returned. The environment is the caller’s session environment.
Authorizations
Cleff API key issued to a Business that self-registers via POST /v1/registration
Path Parameters
Body
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
sandbox, production Logical enrollment provider
"checkbook"
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.
The provider recipient handle dispatch addresses (Checkbook minted user_id)
pending, verified, rejected, suspended, closed Verbatim provider lifecycle token