relay

Generate a Relay claim

Returns a relay's claim.

post/relays/{relay-token}/generate-claim

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/relays/{relay-token}/generate-claim
  • Auth: API key in header Authorization

Path parameters

relay-tokenstring required

The public Relay token returned by POST /relays.

Headers

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

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

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.

Persona-Relay-Secretstring required

The relay-secret value returned at Relay creation. Required for every read of the claim payload; an incorrect secret returns 404.

Response

Returns the claim payload and whether the Privacy Pass token was consumed.

claim-payloadstring required

The claim payload. If an encryption-key-pem was provided at Relay creation, this is a base64-encoded RSA OAEP ciphertext that must be decrypted client-side. Otherwise, this is a JSON string containing claim_type, claim_result, and an optional methodology array.

token-consumedboolean required

true if the Privacy Pass token was consumed by this request. false if the underlying claim did not pass and the token was refunded to the client.

Changes

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