Registration
Register new users and verify email.
Registration
Register new users and verify their email address before granting full account access. The X-App-Id header must be present on all registration requests.
Register
POST /v1/auths/register
Create a new user account. On success, sends a verification email containing a one-time password (OTP). The account is created in an unverified state — full access is granted after email verification.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | Email address for the new account. |
password | string | yes | Password (minimum 8 characters). |
first_name | string | yes | User's first name. |
last_name | string | yes | User's last name. |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/auths/registerSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/auths/register' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"email":"user@example.com","password":"••••••••","first_name":"Jane","last_name":"Doe"}'Verify Email
POST /v1/auths/verify/email
Verify email address with the OTP sent during registration. On success, the account is activated and the user can log in.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | The email address to verify. |
otp | string | yes | 6-digit OTP from the verification email. |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/auths/verify/emailSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/auths/verify/email' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"email":"user@example.com","otp":"123456"}'Resend OTP
POST /v1/auths/resend-otp
Resend OTP for email verification or MFA. Use this when the user did not receive the original email or when the OTP has expired.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | Email address to resend the OTP to. |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/auths/resend-otpSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/auths/resend-otp' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"email":"user@example.com"}'Change Password
POST /v1/auths/change-password
Change password for an authenticated user. Requires a valid JWT. The current password must be provided to prevent unauthorised changes.
| Field | Type | Required | Description |
|---|---|---|---|
current_password | string | yes | The user's current password. |
new_password | string | yes | The new password (minimum 8 characters). |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/auths/change-passwordSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/auths/change-password' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"current_password":"••••••••","new_password":"••••••••"}'