Get a User Data Capture form

GET/user-data-capture/forms/{formId}

user-data-capture:read get_user_data_capture_form_legacyRead-onlyDeprecatedSunset 2027-06-30

Returns one form with its fields in the old shape, with the display-string status and +00:00 timestamps. Deprecated: withdrawn on 2027-06-30. GET /data-capture-forms/{id} replaces it; the Link header names it.

Path parameters

formIdstring (uuid)Required#
The user-data-capture form's public uuid.

Responses

200

UserDataCaptureForm

{
  "data": {
    "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "name": "KYC profile",
    "status": "Enabled",
    "field_count": 2,
    "fields": [
      {
        "reference": "tax_residency",
        "label": "Tax residency",
        "name": "tax_residency",
        "type": "TEXT",
        "allowed_values": null,
        "required": true
      },
      {
        "reference": "investor_category",
        "label": "Investor category",
        "name": "investor_category",
        "type": "DROPDOWN",
        "allowed_values": [
          "retail",
          "professional"
        ],
        "required": false
      }
    ],
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-20T14:05:12+00:00"
  }
}

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

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/user-data-capture/forms/{formId}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"