Skip to main content
POST
Parse a person's name

Authorizations

Authorization
string
header
required

Workspace API key (loice_sk_ + 48 hex characters), created under Settings → API Keys. Sent as Authorization: Bearer loice_sk_…. Invalid, missing, or expired keys are rejected with 401 before any billable work happens.

Headers

Idempotency-Key
string

Optional, 1–255 printable ASCII characters, scoped to your workspace. Send the same key when you retry the same request: the original outcome is replayed (replay: true, charged: false, pointsCharged: 0) instead of running and charging again. The same key with a different request is refused with 409 idempotency_conflict, as is a key reused after its replay record expired (kept 30 days); a key whose first request is still running answers 409 idempotency_in_progress. Without a key, every request is a new lookup, billed at most once on its own.

Required string length: 1 - 255

Body

application/json
name
string
required

The person's full name as you have it, in any order (Smith, John, PODSEKIN Igor, Ludwig van Beethoven). At least one non-blank character, at most 256 characters.

Required string length: 1 - 256
spelling
enum<string>

as-written (default) returns the words as you sent them, cleaned of honorifics, credentials and asides. folded returns the key spelling: lower case, diacritics removed (José Núñez → jose / nunez).

Available options:
as-written,
folded

Response

The name, split. first/last always equal given/surname. charged, pointsCharged and replay say what the call cost; a replay is never charged again.

data
object
required