Onboarding

Attach a classification gate to an onboarding flow

POST/onboarding/flows/{complianceId}/classifications
onboarding:writeattach_compliance_classificationDeprecatedSunset 2027-06-30

Attaches a classification gate to the onboarding flow. classification_id is the investor-class id (scoped to the token organisation); an id that is not a classification of your organisation is a 422. Attaching a classification the flow already gates on returns the existing gate. Deprecated: withdrawn on 2027-06-30. POST /onboarding-flows/{onboarding_flow_id}/classifications replaces it; the Link header names it.

Path parameters

  • complianceIdstring (uuid)Required#

    The compliance flow's public uuid.

Request body

application/json, required

  • classification_idintegerRequired#

    The investor-classification id to gate on.

{
  "classification_id": 42
}

Responses

201

Created

ComplianceClassificationGate
{
  "data": {
    "id": "f6a1b2c3-d4e5-4071-8293-a4b5c6d7e8f9",
    "compliance_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "classification_id": 42
  }
}
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}/classifications\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "classification_id": 42
}'