Skip to main content
POST

​
Description

Provisions a user in ZBD for your project. Idempotent — if a user with the same reference_id or email already exists for your project, the existing user is returned. Call this from your server before creating a widget session.
Some cashout methods require the user to accept the latest disclosure before cashout can proceed. The hosted widget can collect this during the session. If your integration records disclosure acceptance before opening the widget, see Disclosure Agreements.

​
Configuration

​
Header Parameters

​
apikey
string
required
Your ZBD project API key (production scope).
​
Content-Type
string
Content Type

​
Body Parameters

​
reference_id
string
required
Your stable internal user identifier. Must be unique per project.
​
email
string
required
User’s email address. Used for OTP verification in the widget.

​
Response

The response data includes the new (or existing) user plus an outstanding_disclosures array — the disclosure versions this user still needs to accept. This is returned on the first user request, so you have the user’s outstanding disclosures immediately, with no extra call.
​
outstanding_disclosures
array
Disclosure versions the user has not yet accepted. Empty when the user is current on all disclosures. Each entry includes id, type_id, name, description, version, content_uri, created_at, and due_date.
outstanding_disclosures lists only what is still outstanding. To list a user’s full acceptance state (including what they have already accepted), call Get Disclosure Status at any time. See Disclosure Agreements for the full model.