User Data Capture

List the firm's User Data Capture field schema

GET/user-data-capture/fields
user-data-capture:readlist_user_data_capture_fields_legacyRead-onlyDeprecatedSunset 2027-06-30

Lists the firm's enabled field schema, deduped by reference, as a flat { "data": [...] } list. Rows keep the old shape: no description or placeholder. Deprecated: withdrawn on 2027-06-30. GET /data-capture-fields replaces it; the Link header names it.

Responses

200

OK

UserDataCaptureField[]
{
  "data": [
    {
      "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
    }
  ]
}
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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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