WoyraDocs
Get an API key

Create an account and sign in

POST/v1/auth/signup

Console · Public: no credential needed

Creates an account and its owner user. Deployments that require operator approval return the account in **pending** state and issue no API key until a Woyra superuser approves it. Managed partner accounts, such as TalariCloud, are provisioned through the admin API and bypass this public approval queue. A verification email is sent; the account is confirmed. Only served when open signup is enabled on the deployment.

Body

FieldTypeDescription
account_namerequiredstringThe company or product.
namerequiredstringThe person signing up.
emailrequiredstring
passwordrequiredstring
countrystringISO 3166-1 alpha-2. Defaults to the country endpoint's
currencystringDefaults to the country's currency.

Example

curl -X POST https://api.woyra.io/v1/auth/signup \
  -H 'Content-Type: application/json' \
  -d '{
    "account_name": "<account_name>",
    "name": "<name>",
    "email": "alex@example.com",
    "password": "<password>"
  }'

Response

201 Signed in. The api_key.token is shown once.

FieldTypeDescription
object"session"
userUser
accountobject
account.idstring
account.namestring
account.countrystring
account.currencystringThe billing currency.
account.payment_currencystringHow the account pays: USD by card, or ETB by bank deposit credited in USD.
One of ETB, USD.
account.regionstring
One of global, ethiopia.
account.statusstring
account.project_idstring
mfaobject
mfa.enabledbooleanAn authenticator app is on.
mfa.requiredboolean
mfa.pendingboolean
mfa.passkeysintegerHow many passkeys the user has. A passkey counts as a second factor.
mfa.recovery_codesintegerUnused recovery codes left.
sessionobject
session.idstring
session.expires_attimestamp
api_keyobjectOnly on signup — the test key, with its token shown once.

Errors

StatusCodes
400invalid_request, unsupported_version
404not_found, product_not_offered
429rate_limited, daily_send_limit_reached

Also in Console