Skip to navigation
API ReferenceRelay

Create a Relay

Creates a new Relay.

Headers

Key-InflectionenumOptional
Determines casing for the API response.
Allowed values:
Persona-VersionenumOptional

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

Request

This endpoint expects an object.
claim-typestringRequired

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 or nullRequired

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.

sandboxbooleanOptional

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 headers

RateLimit-Limitinteger

The maximum number of requests permitted in the current rate limit window. For an API key with its own rate limit, requests count against both the key's limit and the environment's limit, and this header reports whichever is closer to being reached, so it can change between responses. On a 429 response, it reports the limit that rejected the request. For an API key without its own rate limit, it reports the environment's limit. Returned on every authenticated response.

RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window for the limit reported in RateLimit-Limit. Returned on every authenticated response.

RateLimit-Resetinteger
The number of seconds until the current rate limit window resets. Returned on every authenticated response.
Request-IdstringOptional

The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.

Persona-Environment-IdstringOptional
The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.
Persona-Organization-IdstringOptional
The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.

Response

Returns the Relay tokens needed to redeem and read the claim.
relay-tokenstring

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

relay-secretstring

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error