User Data Capture

List data capture fields

GET/data-capture-fields
user-data-capture:readget_data_capture_fieldsRead-only

Lists the fields users are asked for: the fields of every enabled data capture form that have a reference, one row per reference (when forms share one, which form's row is kept is not defined). It is a single list with no paging. Fields of disabled and internal_only forms are left out, even for an internal user. A row's reference is its key under data_capture on GET /investors/{id}. Use GET /data-capture-forms to manage the forms. It changes nothing.

Responses

200

Every field users are asked for.

DataCaptureField[]
{
  "data": [
    {
      "reference": "nationality",
      "label": "Nationality",
      "name": "nationality",
      "type": "TEXT",
      "description": "As it appears on your passport.",
      "placeholder": "e.g. United Kingdom",
      "allowed_values": null,
      "required": false
    },
    {
      "reference": "investor_category",
      "label": "Investor category",
      "name": "investor_category",
      "type": "DROPDOWN",
      "description": null,
      "placeholder": null,
      "allowed_values": [
        "retail",
        "professional"
      ],
      "required": true
    }
  ]
}
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/data-capture-fields\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"