relay

Create a Relay

Creates a new Relay.

post/relays

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/relays
  • 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.

encryption-key-pemstring nullable required

RSA public key (PEM-encoded, 2048-4096 bits). When non-null, claim payloads returned by subsequent reads will be encrypted with RSA OAEP. Pass null to receive unencrypted claim payloads.

sandboxboolean

When true, the Relay is created in a sandbox environment and uses the sandbox Privacy Pass namespace; sandbox passes are only redeemable against sandbox Relays. When omitted or false, the Relay is created in a production environment and uses the claim-type namespace.

Response

Returns the Relay tokens needed to redeem and read the claim.

relay-tokenstring required

Public Relay identifier. Use this token in subsequent calls to /relays/{relay-token}/generate-claim.

relay-secretstring required

Secret value tied to this Relay. Returned only at creation and must be passed in the Persona-Relay-Secret header for any read of the claim payload.

relay-session-access-tokenstring required

Encoded JWT used by Persona's client SDK to load the associated Inquiry Session in the end-user's browser or device.

Changes

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