Onboard for action
Start the exact provider-account creation step and open its first-party signup link.
webLink; the provider confirms account creation before the Action can continue. Do not send profile fields, passwords, codes, or a claimed signup result in the request.
Developer settings
Authorizations
Pass your Darwin API key in the x-api-key header. You can also authenticate with Authorization: Bearer .
Path Parameters
The Action identifier returned by Start action or List actions.
1 - 200Body
Start only the current, server-bound provider signup interaction. Personal details, passwords, one-time codes, and acceptance of provider terms belong in the hosted flow, not this request.
Response
The current truthful state of the action.
start, status, update, approve, stop, onboard, pay, connect "onboard"completed, running, awaiting_user, approval_required, onboarding_required, connection_required, payment_required, insufficient_authority, provider_unavailable, stopped status, update, approve, onboard, pay, connect, stop The exact provider-account creation step bound to the Action. The provider, account type, required fields, and terms are reviewed in the first-party browser flow.
- Onboarding
- Onboarding
- Onboarding