Mint an identity token

The Ada end user ID to identify the messaging session as

An optional email address whose ownership your server has verified. Ada links only when the mint request includes this field. Warning: Ada links to or creates a Zendesk user from the email. A wrong email links the conversation to another person's Zendesk user. Read all risks. Send it only from your server when you mint the identity token. Ada removes surrounding whitespace and accepts valid addresses of at most 254 characters after trimming. Ada carries the linking values encrypted in the identity token. Ada stores the values encrypted on the session's end user. Ada uses them only in the first 7 days after the exchange. Ada deletes them after the first Zendesk Messaging handoff uses them and Sunshine initialization succeeds. If no handoff uses them, Ada deletes them at the next handoff or token exchange after the 7 days end. Session refresh does not extend this window. A new exchange replaces the previous linking values. Sunshine initialization errors keep the value available for a retry. When the request includes this field, exchange updates the display copy jwt_email. A missing or empty value clears its previous display copy only if that copy still matches the value Ada wrote. Claim clearing also clears this display copy only if it still matches the value Ada wrote. Ada never writes META email or reads the display copy for identity. Tokens contain no plaintext name or email. Ada omits the linking values from API responses, end-user resources, and webhooks. Ada sends display copies to the end user's browser and shows them in the dashboard.

The end user's optional name, supplied only by your server when you mint the identity token. Ada stores and displays this name only when the mint request includes it. Ada links to or creates a Zendesk user only when the request also includes verified_email. Ada removes surrounding whitespace and accepts at most 255 characters after trimming. Ada carries the linking values encrypted in the identity token. Ada stores the values encrypted on the session's end user. Ada uses them only in the first 7 days after the exchange. Ada deletes them after the first Zendesk Messaging handoff uses them and Sunshine initialization succeeds. If no handoff uses them, Ada deletes them at the next handoff or token exchange after the 7 days end. Session refresh does not extend this window. A new exchange replaces the previous linking values. Sunshine initialization errors keep the value available for a retry. If verified_email is present and this name is empty or absent, handoffs use the profile first_name and last_name. When the request includes this field, exchange updates the display copy jwt_name. A missing or empty value clears its previous display copy only if that copy still matches the value Ada wrote. Exchange updates META name only when empty or equal to the previous token-derived name. Claim clearing also clears jwt_name and META name only if they still match the values Ada wrote. Ada never reads display copies for identity. Tokens contain no plaintext name or email. Ada omits the linking values from API responses, end-user resources, and webhooks. Ada sends display copies to the end user's browser and shows them in the dashboard.

Short-lived, single-use JWT exchanged by the Messaging SDK

Token type

Fixed identity token lifetime in seconds