Skip to navigation

Schemas

Claim payload

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

ClaimPayload

FieldTypeDescription
claim_typestringThe claim type that was evaluated
claim_result'passed' | 'failed'The outcome of the claim
methodologyMethodologyCalculation[]Optional. Lists each verification method used and its result. Not included for claim types that hide methodology (see the Methodology in payload column under Claim types). When hidden, the field is left out of the payload entirely.

MethodologyCalculation

FieldTypeDescription
method'facial_age_estimation' | 'document_selfie' | 'live_selfie'The verification method used
result'passed' | 'failed'The outcome of this method

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

Claim type nameDescriptionMethodology in payload
Live Human PresenceEvaluates whether a real person is present at the time of verification.Yes
Verified Human PresenceEvaluates whether a real person is present using a higher-assurance verification approach.Yes

Age

Claim type nameDescriptionMethodology in payload
Age 18+ GermanyEvaluates whether a user meets an 18+ age threshold using an approach designed for Germany-related use cases.Yes
Age 18+ United KingdomEvaluates whether a user meets an 18+ age threshold using an approach designed for United Kingdom-related use cases.Yes
Age 18+ FranceEvaluates whether a user meets an 18+ age threshold using an approach designed for France-related use cases.No
Age 18+ ItalyEvaluates whether a user meets an 18+ age threshold using an approach designed for Italy-related use cases.No
Age 18+ AustraliaEvaluates whether a user meets an 18+ age threshold using an approach designed for Australia-related use cases.Yes
Age 16+ AustraliaEvaluates whether a user meets a 16+ age threshold using an approach designed for Australia-related use cases.Yes
Age 18+ BrazilEvaluates whether a user meets an 18+ age threshold using an approach designed for Brazil-related use cases.Yes
Age 18+ VerifiedEvaluates whether a user meets an 18+ age threshold using a high-assurance age verification approach.Yes
Age 21+ VerifiedEvaluates whether a user meets a 21+ age threshold using a high-assurance age verification approach.Yes

Error responses

All Relay API endpoints return errors in the following shape:

{
"errors": [
{
"status": "401",
"title": "Unauthorized",
"detail": "..."
}
]
}
StatusDescription
400Bad request — missing or invalid parameters
401Unauthorized — invalid or missing API key or relay secret
403Forbidden — relay secret does not match, or claim not yet available
404Not found — relay token does not exist
429Rate limited
500 / 502 / 503 / 504Server error