Skip to main content
POST
Onboard for action
This operation is a planned preview and is not callable in production yet.
The request starts only the current onboarding interaction. Darwin returns an Action with a first-party 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

Manage the credential that will call Act when this preview becomes available.

Authorizations

x-api-key
string
header
required

Pass your Darwin API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Path Parameters

actionId
string
required

The Action identifier returned by Start action or List actions.

Required string length: 1 - 200

Body

application/json

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.

interactionId
string
required
Required string length: 1 - 200
expectedRevision
integer
required
Required range: x >= 1
requestId
string
required
Required string length: 1 - 160
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9._:-]*$

Response

The current truthful state of the action.

type
enum<string>
required
Available options:
start,
status,
update,
approve,
stop,
onboard,
pay,
connect
Allowed value: "onboard"
actionId
string
required
status
enum<string>
required
Available options:
completed,
running,
awaiting_user,
approval_required,
onboarding_required,
connection_required,
payment_required,
insufficient_authority,
provider_unavailable,
stopped
result
object
required
actionRequired
string | null
required
availableActions
enum<string>[]
required
Available options:
status,
update,
approve,
onboard,
pay,
connect,
stop
interaction
Onboarding · object
required

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.

feedbackRequest
object
policyState
object
Last modified on September 22, 2026