Skip to Content
POST
/api/v1/identities/{identityId}/webauthn/credentials

Verifies the browser WebAuthn attestation response and stores the enrolled security key.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

identityId*string

Mailbox identity ULID

Request Body

application/json
  1. body
name?string

User-chosen label for the security key (e.g. 'YubiKey 5')

Lengthlength <= 128
origin*string

Origin URL of the web page where ceremony took place

Lengthlength <= 1024
response*
rpId*string

Relying Party ID (domain hostname)

Length1 <= length <= 253

Response Body

Enrolled security key details

application/json
  1. response
createdAt*integer

Enrollment timestamp in epoch seconds

Formatint64
id*string

Unique WebAuthn credential ULID

lastUsedAt*|

Timestamp when key was last used for authentication, or null

Formatint64
name*|

User-assigned name for the security key or passkey

rpId*string

Relying party ID (hostname) the key is bound to

transports*array<string>|

Supported authenticator transports (usb, nfc, ble, internal)

Example Request
curl -X POST 'https://api.open.email/api/v1/identities/string/webauthn/credentials' \
  -H 'Content-Type: application/json' \
  -d '{
  "origin": "string",
  "response": {
    "attestationObject": "string",
    "clientDataJSON": "string"
  },
  "rpId": "string"
}'
Example Response
{
  "createdAt": 0,
  "id": "string",
  "lastUsedAt": 0,
  "name": "string",
  "rpId": "string",
  "transports": [
    "string"
  ]
}