relay

Request a Relay challenge

Requests a Privacy Pass challenge for a claim type. The challenge materials returned here are used to obtain a Privacy Pass token, which is then redeemable to read claims from Relays with the same claim type.

post/relays/challenge

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/relays/challenge
  • Auth: none declared

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Request body

claim-typestring required

Possible values:

  • live_human_presence
  • age_over18_germany
  • age_over18_united_kingdom
  • age_over18_verified
  • age_over18_france
  • age_over18_italy
  • age_over18_brazil
  • age_over18_australia
  • age_over16_australia
  • age_over21_verified

Do not assume this is a static enumeration; Persona may add new claim types in the future without a versioned update.

sandboxboolean

When true, Persona issues a sandbox-namespace challenge, redeemable only against sandbox Relays. When omitted or false, Persona issues a challenge for the claim-type namespace.

Response

Returns the Privacy Pass challenge materials for the requested claim type.

challengestring required

base64url-encoded PrivateToken challenge object (RFC 9577). Pass this to the Privacy Pass issuance flow to obtain a token.

token-keystring required

base64url-encoded DER public key used to issue the token.

token-key-idstring required

hex-encoded SHA-256 of token-key.

Changes

No recorded changes to this operation across all 1 revision of this API.