Add a section/form to an onboarding flow

POST/onboarding/flows/{complianceId}/forms

onboarding:write attach_compliance_formDeprecatedSunset 2027-06-30

Creates a hidden, published section/form and links it to the onboarding flow as a new section. Deprecated: withdrawn on 2027-06-30. POST /onboarding-flows/{onboarding_flow_id}/forms replaces it; the Link header names it.

Path parameters

complianceIdstring (uuid)Required#
The compliance flow's public uuid.

Request body

application/json, required

namestringRequired#
descriptionstring | null#

{
  "name": "Source of Wealth",
  "description": "Declaration of the source of investable funds."
}

Responses

201

Created

ComplianceForm

{
  "data": {
    "id": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112",
    "compliance_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "form_id": "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9",
    "name": "Source of Wealth",
    "is_start": false
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

404

Resource not found (error.code = not_found).

Error

422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/onboarding/flows/{complianceId}/forms\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Source of Wealth",
  "description": "Declaration of the source of investable funds."
}'