Skip to navigation

Create a Child Account onboarding intent

Beta

Opens the intent that sets up the payment method of a Child Account. Name the Child Account and the person who signs for it. The answer lists the steps that are due. A Child Account has one open intent at a time. A repeat with the same Idempotency-Key and body returns the first intent.

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/

Headers

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

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

Allowed values:

Request

This endpoint expects an object.
dataobjectRequired
The intent to open.

Response

The intent that was opened.
dataobject
The intent.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error