Sign in with email and password
POST/v1/auth/login
With two-factor authentication enabled, the response has mfa.pending: true and the session can only be used to call /v1/auth/mfa/verify within five minutes. Wrong credentials and unknown addresses get the same answer, and ten failures in fifteen minutes lock the address out for the rest of the window.
When the deployment runs Cloudflare Turnstile (see /v1/auth/config), sign-up, sign-in and password reset also need the widget's token in the Woyra-Turnstile header; without it they answer 400 invalid_request.
Body
| Field | Type | Description |
|---|---|---|
| emailrequired | string | |
| passwordrequired | string |
Example
curl -X POST https://api.woyra.io/v1/auth/login \
-H 'Content-Type: application/json' \
-d '{
"email": "alex@example.com",
"password": "<password>"
}'Response
200 Signed in, or awaiting the second factor.
| Field | Type | Description |
|---|---|---|
| object | "session" | |
| user | User | |
| account | object | |
| account.id | string | |
| account.name | string | |
| account.country | string | |
| account.currency | string | The billing currency. |
| account.payment_currency | string | How the account pays: USD by card, or ETB by bank deposit credited in USD. One of ETB, USD. |
| account.region | string | One of global, ethiopia. |
| account.status | string | |
| account.project_id | string | |
| mfa | object | |
| mfa.enabled | boolean | An authenticator app is on. |
| mfa.required | boolean | |
| mfa.pending | boolean | |
| mfa.passkeys | integer | How many passkeys the user has. A passkey counts as a second factor. |
| mfa.recovery_codes | integer | Unused recovery codes left. |
| session | object | |
| session.id | string | |
| session.expires_at | timestamp | |
| api_key | object | Only on signup — the test key, with its token shown once. |
Errors
| Status | Codes |
|---|---|
| 401 | authentication_required, invalid_api_key |
| 429 | rate_limited, daily_send_limit_reached |
Also in Console
- POST /v1/auth/signup — Create an account and sign in
- POST /v1/auth/logout — End the session
- GET /v1/auth/config — What a sign-in page needs before anyone signs in
- GET /v1/auth/me — The signed-in user, account and MFA state
- POST /v1/auth/mfa/verify — Finish signing in with a TOTP code or a recovery code
- POST /v1/auth/passkeys/login/begin — Start signing in with a passkey
- POST /v1/auth/passkeys/login/finish — Finish signing in with a passkey
- GET /v1/auth/passkeys — The signed-in user's passkeys
- POST /v1/auth/passkeys/register/begin — Start adding a passkey
- POST /v1/auth/passkeys/register/finish — Finish adding a passkey
- DELETE /v1/auth/passkeys/{id} — Remove a passkey
- POST /v1/auth/recovery_codes — Make a fresh set of recovery codes
- POST /v1/auth/mfa/enrol — Start TOTP enrolment
- POST /v1/auth/mfa/confirm — Confirm TOTP enrolment with a code
- DELETE /v1/auth/mfa — Disable TOTP
- POST /v1/auth/verify-email — Confirm an email address from its link
- POST /v1/auth/resend-verification — Send the verification email again
- POST /v1/auth/forgot-password — Request a password reset link
- POST /v1/auth/reset-password — Set a new password from a reset link
- POST /v1/auth/change-password — Change the password while signed in
- GET /v1/auth/invites/{token} — Describe an invitation before accepting it
- POST /v1/auth/invites/accept — Accept an invitation and sign in
- GET /v1/console/overview — Dashboard counts
- GET /v1/console/analytics — Daily series and the route view
- GET /v1/console/stream — Live message events
- GET /v1/audit_events — The account's audit trail