Skip to main content
POST
/
persons
/
{person_id}
/
claims
Create a claim for a person
curl --request POST \
  --url https://api.engine.usesophic.com/persons/{person_id}/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_type": "<unknown>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25"
}
'
{
  "id": "<string>",
  "claim_type": "<unknown>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "person": "<string>",
  "status": "pending",
  "verified_at": "2023-11-07T05:31:56Z",
  "superseded_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "lifecycle": "active",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

person_id
string
required

The ID of the person.

Body

application/json

Spec for identity claim data.

claim_type
any
required
first_name
string
required
last_name
string
required
date_of_birth
string<date>
required

Response

Created

Identity claim response (first/last name, date of birth).

id
string
required

Unique resource identifier.

claim_type
any
required
first_name
string
required
last_name
string
required
date_of_birth
string<date>
required
person
string
required

ID of the person this claim belongs to.

status
enum<string>
required

The status of the claim (pending or verified). A verified claim whose superseded_at is non-null is historical -- a newer verified claim of the same type has taken over. A pending claim whose archived_at is non-null is historical -- a newer pending of the same type has replaced it.

Available options:
pending,
verified
verified_at
string<date-time> | null
required

When the claim was verified (in ISO-8601 format); null if still pending.

superseded_at
string<date-time> | null
required

When the claim was superseded by a newer verified claim (in ISO-8601 format); null if this is the current row for its type.

archived_at
string<date-time> | null
required

When the pending claim was archived because a newer pending of the same (person, claim_type) replaced it (in ISO-8601 format); null if this is the current pending. Only ever set on pending rows.

lifecycle
enum<string>
required

Derived role of this row within its (person, claim_type) group, computed from status, archived_at, and superseded_at. active is a verified row with superseded_at IS NULL. in_flight is a pending row with archived_at IS NULL. historical covers archived pendings and superseded verifieds kept for audit. Prefer reading the raw columns directly if you already know which case you care about; this field exists so consumers can keep a single discriminator across the three column values.

Available options:
active,
in_flight,
historical
created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the claim was created.