---
title: "Mint the signed identity the Help Scout Beacon needs"
method: POST
path: "/helpscout/identity/"
tags: ["helpscout"]
---

# Mint the signed identity the Help Scout Beacon needs

`POST /helpscout/identity/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/helpscout/identity/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Sign the user's email address with the Beacon secure-mode key, and return it with the details the support widget fills its form and conversation with.

## Response `200`

Successful Response

- HelpScoutIdentity: Who the Beacon should say is writing, and the proof that it is them. The email is returned rather than read from Clerk in the browser because it is the string the signature was computed over: a Beacon handed a different address than the one that was signed fails secure mode silently.
  - `company` string, required: The workspace they are writing from.
  - `email` string, required: The address the signature below was computed over.
  - `name` string, nullable, required: The customer's full name, or null when Clerk holds neither part.
  - `org_id` string, required: Clerk organization id, for looking the workspace up.
  - `role` string, required: Their role in that workspace.
  - `signature` string, required: HMAC-SHA256 hex signature of the email, which Beacon secure mode checks before it trusts the identity the page claims.
  - `user_id` string, required: Clerk user id, for looking the person up.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)