Skip to content
Authrim

Send a code to the email an invitation names.

POST
/api/v1/invitations/email-verification/send
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/v1/invitations/email-verification/send \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Sends a one-time code to the invited email of an active invitation (never to an address the request gives), so a passkey or authenticator-app signup can prove it controls that email when the tenant requires it (authentication-methods.invitation.email_verification). Limited per invitation like other email sends.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
token
required
string
>= 32 characters
key
additional properties
Example generated
{
  "token": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The code was sent.

Media type application/json
object
verification_id
required
string
expires_in
required
integer
masked_email
required
string
Example 
{
  "expires_in": 600,
  "masked_email": "i***@example.com"
}

404

Section titled “404 ”

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
  }
}

429

Section titled “429 ”

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
  }
}