Generate a Relay claim
Returns a relay's claim.
Authentication
AuthorizationPrivateToken token=
Privacy Pass token per RFC 9577. Provide as Authorization: PrivateToken token=<privacyPassToken>.
Path parameters
relay-token
The public Relay token returned by POST /relays.
Headers
Key-Inflection
Determines casing for the API response.
Allowed values:
Idempotency-Key
Ensures the request is idempotent.
Persona-Version
Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
Persona-Relay-Secret
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-payload
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-consumed
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.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error