1. Docs
  2. API Reference
  3. Accept an invite

Accept an invite

POST/v1/identity/auth/accept-invite

Request body

  • tokenstring*
  • first_namestring

    Required for `activate` invites. Ignored for `add_to_app` and `password_reset`.

  • last_namestring

    Required for `activate` invites. Ignored for `add_to_app` and `password_reset`.

  • passwordstring*

    Password (8-64 chars). No composition rules — NIST SP 800-63B aligned. HaveIBeenPwned breach check runs server-side. For `activate` and `password_reset` this is the new password; for `add_to_app` it is the existing password used to verify the identity.

Code samples

cURLJavaScriptPythonGo
curl -X POST "https://api.canopy.dev/v1/identity/auth/accept-invite" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "string",
    "first_name": "string",
    "last_name": "string",
    "password": "string"
  }'

Responses

200 Invite accepted, user created or updated
{
  "message": "string"
}

application/json

  • messagestring*

Returned object

On this page

Related endpoints

POSTAuthenticate identity and receive tokens
POSTIdentity multi-App login: complete Application selection from pre-auth session
POSTRefresh identity access token
POSTLogout identity and revoke tokens
POSTVerify identity email address
POSTResend identity verification email
POSTRequest identity password reset
POSTReset identity password with token
POSTChange identity password (authenticated)
GETGet current identity profile
GETList identity active sessions
DELETERevoke a specific identity session
POSTLook up invite details by token