Schemas

Claim payload

When encryptionKeyPem is null, claimPayload is a JSON string. Once parsed (JSON.parse(claimPayload)), it has the following shape:

ClaimPayload

MethodologyCalculation

Claim types

To obtain the Claim Type ID needed to create a Relay session, navigate to Persona Dashboard → Relay. Additional details, including supported use cases, verification approaches, and implementation guidance for each claim type, are also available in the Dashboard.

Humanness

Age

PersonaError

Base class for all TypeScript SDK errors. Extends Error.

Error responses

All Relay API endpoints return errors in the following shape:

1
{
2
  "errors": [
3
    {
4
      "status": "401",
5
      "title": "Unauthorized",
6
      "detail": "..."
7
    }
8
  ]
9
}