Presets · List available

GET /presets

cURL

cURL

curl --request GET \
  --url https://api.sandbox.humanity.org/v2/presets

200

{
  "presets": [
    {
      "name": "<unknown>",
      "scope": "<unknown>",
      "category": "<unknown>",
      "description": "<string>",
      "consentText": "<string>",
      "type": "<unknown>",
      "sensitivity": "<unknown>",
      "derived": true,
      "parentField": "<unknown>"
    }
  ]
}

SDK equivalent

const presets = await sdk.listPresets();

Returns the complete catalog of available presets with their metadata, required scopes, categories, and sensitivity levels.

Use this endpoint to:

• Discover which presets are available in your environment
• Build dynamic consent UIs based on preset metadata
• Understand scope requirements for each preset

Response Structure

Each preset in the response includes:

Field	Description
name	Preset identifier (e.g., is_human, age_over_21)
scope	OAuth scope required to access this preset
category	Grouping: identity, kyc, financial, profile
description	Human-readable description
consentText	Text shown to users during consent
type	Data type: boolean, string, number, integer, date, datetime, array, enum
sensitivity	Data sensitivity: low, medium, high, critical
derived	Whether this preset is computed from another field
parentField	For derived presets, the source field

Example Response

{
  "presets": [
    {
      "name": "is_human",
      "scope": "identity:read",
      "category": "identity",
      "description": "True if passed a KYC check OR palm enrollment via mobile app or hardware",
      "consentText": "Verify you are a real, unique person",
      "type": "boolean",
      "sensitivity": "medium",
      "derived": false
    },
    {
      "name": "age_over_21",
      "scope": "identity:date_of_birth",
      "category": "identity",
      "description": "Whether user is ≥ 21",
      "consentText": "Confirm you are 21 or older",
      "type": "boolean",
      "sensitivity": "low",
      "derived": true,
      "parentField": "date_of_birth"
    }
  ]
}

Preset Categories

Category	Description
identity	Basic identity attributes, email, phone, wallet, country
kyc	KYC verification status and document information
financial	Net worth, bank balances, loan information
profile	Bundled profile data like humanity_user

Sensitivity Levels

Level	Description	Example Presets
low	Minimal privacy impact	age, humanity_score, social connections
medium	Standard PII	is_human, country_of_residence, kyc_passed
high	Sensitive PII requiring explicit consent	date_of_birth, legal_name, document_number
critical	Highly sensitive financial/tax data	Tax IDs (when available)

Response

200 - application/json

presets · object[] · required

Show child attributes