Skip to navigation

Execute a Child Account onboarding intent action

Beta

Does the action of a step that is due. A signer step answers a one-time link in action_result.url: send the signer there. The link runs every signer step that is due. A new call stops the previous link if the signer has not opened it yet. A repeat with the same Idempotency-Key and body returns the first answer with a new token for the same link, or 409 ACTION_RESULT_EXPIRED when that link no longer works. An action that is not due answers 409. Answers 404 while the feature is not open to you.

Token scopes: organizations:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-16.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

intent_idstringRequired
Id of the intent.
action_keystringRequired

Key of the step to do, as in next_actions of the intent.

Headers

Idempotency-KeystringRequired
A UUID that identifies this call. A repeat with the same key and body returns the first answer.
X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Request

The body of the action, as body_schema in next_actions. The signer steps take an empty object; verify_bank_account takes the two micro-deposit amounts.

dataobjectOptional

Response

The intent and what to do next for the action.
dataobject
The intent after the action.
action_resultobject
What the partner does next for the action.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error