Endpoints

Auth intake

POST/v0/companies/{company_id}/projects/{project_id}/auth-intake/embed-token

Mint an auth-intake token for a new patient

Route #1 — brand-new patient. Optional demographics pre-fill the form; an optional site makes the authorization site-specific.

Request bodyapplication/json

object

ReturnsSuccess

tokenstring
The embed token: an opaque encrypted string to pass to the embed as its `token` query parameter. It grants access to what it was minted for until it expires, so mint a fresh one rather than storing it.

Errors

400401404500

Request

curl

curl https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/auth-intake/embed-token \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "parentOrigin": "https://www.example.com",
  "demographics": {
    "firstName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "1990-04-12",
    "sex": "male",
    "zipCodes": [
      "string"
    ],
    "ssn": "string",
    "email": "jane.doe@example.com",
    "mobile": "+12025550142"
  },
  "siteId": "site_example123"
}'

import requests

response = requests.post(
    "https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/auth-intake/embed-token",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "parentOrigin": "https://www.example.com",
        "demographics": {
            "firstName": "Jane",
            "lastName": "Doe",
            "dateOfBirth": "1990-04-12",
            "sex": "male",
            "zipCodes": [
                "string",
            ],
            "ssn": "string",
            "email": "jane.doe@example.com",
            "mobile": "+12025550142",
        },
        "siteId": "site_example123",
    },
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/auth-intake/embed-token", {
    method: "POST",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "parentOrigin": "https://www.example.com",
      "demographics": {
        "firstName": "Jane",
        "lastName": "Doe",
        "dateOfBirth": "1990-04-12",
        "sex": "male",
        "zipCodes": [
          "string"
        ],
        "ssn": "string",
        "email": "jane.doe@example.com",
        "mobile": "+12025550142"
      },
      "siteId": "site_example123"
    }),
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();

Response

json

{
  "token": "string"
}

POST/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/auth-intake/embed-token

Mint an auth-intake token for a patient

Route #2 — existing patient, broad authorization.

Request bodyapplication/json

object

ReturnsSuccess

tokenstring
The embed token: an opaque encrypted string to pass to the embed as its `token` query parameter. It grants access to what it was minted for until it expires, so mint a fresh one rather than storing it.

Errors

400401404500

Request

curl

curl https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/auth-intake/embed-token \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "parentOrigin": "https://www.example.com"
}'

import requests

response = requests.post(
    "https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/auth-intake/embed-token",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "parentOrigin": "https://www.example.com",
    },
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/auth-intake/embed-token", {
    method: "POST",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "parentOrigin": "https://www.example.com"
    }),
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();

Response

json

{
  "token": "string"
}

POST

/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/record-requests/{request_id}/auth-intake/embed-token

Mint an auth-intake token for a record request

Route #3 — existing patient + record request, site-specific authorization.

Request bodyapplication/json

object

ReturnsSuccess

tokenstring
The embed token: an opaque encrypted string to pass to the embed as its `token` query parameter. It grants access to what it was minted for until it expires, so mint a fresh one rather than storing it.

Errors

400401404500

Request

curl

curl https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<request_id>/auth-intake/embed-token \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "parentOrigin": "https://www.example.com"
}'

import requests

response = requests.post(
    "https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<request_id>/auth-intake/embed-token",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "parentOrigin": "https://www.example.com",
    },
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.hermeshealth.ai/v0/companies/<company_id>/projects/<project_id>/patients/<patient_id>/record-requests/<request_id>/auth-intake/embed-token", {
    method: "POST",
    headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "parentOrigin": "https://www.example.com"
    }),
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();

Response

json

{
  "token": "string"
}