Skip to content
Authrim

Validate an invitation token.

GET
/api/v1/invitations/validate
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/v1/invitations/validate?token=example'

Validates a public invitation token and returns tenant and invited-email metadata used by the invitation landing page.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
token
required
string
>= 32 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Invitation validation response.

Media type application/json
object
valid
required
boolean
invitation_id
required
string
tenant_id
required
string
tenant_name
required
string
invited_email
string | null format: email
expires_at
required
integer
Example 
{
  "valid": true,
  "invitation_id": "inv_123",
  "tenant_id": "tenant_123",
  "tenant_name": "Example Tenant",
  "invited_email": "[email protected]",
  "expires_at": 1770000000
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}