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](https://docs.withpersona.com/versioning).

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 nullOptional

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

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