Key Inflection

The Key-Inflection header lets you control the casing of JSON keys in API responses. This is useful when integrating with systems that expect a specific naming convention.

Options

ValueExample keyDescription
snake (default)face_match_passedSnake case — words separated by underscores.
camelfaceMatchPassedCamel case — first word lowercase, subsequent words capitalized.
kebabface-match-passedKebab case — words separated by hyphens.

Usage

$curl https://api.withverifa.com/api/v1/sessions/session_abc123/result \
> -H "X-API-Key: vk_live_your_key_here" \
> -H "Key-Inflection: camel"
1{
2 "session_id": "session_abc123",
3 "face_match_passed": true,
4 "face_match_score": 0.94,
5 "extracted_data": {
6 "first_name": "Jane",
7 "last_name": "Doe",
8 "date_of_birth": "1997-06-15"
9 }
10}

Notes

  • Key inflection applies to response bodies only. Request bodies should always use snake case.
  • The Key-Inflection header is optional. If omitted, responses use snake case.
  • You can also set a default key inflection per webhook endpoint, so webhook payloads are delivered in your preferred casing.