POST
Register a client account
No sign-in needed For: Everyone Conditions
  • No sign-in is needed; the route allows 5 calls per minute.
  • The token must be a sign-up token issued by check-email for the same email address as the request, not expired and not already used; this is checked before any other field.
  • The email must be a valid address not used by any existing account, and the phone number must not be used by any existing account (accounts that were deactivated still count).
  • The password needs at least 8 characters with lower case, upper case, a digit and a symbol.
  • A client name, a currency code of 3 characters in upper case and an exponent from 0 to 6 are required; currency defaults to XOF with exponent 0 when omitted.
What else happens
  • Creates the account (active, email not yet verified).
  • Creates a new organization named by organization.name, owned by the person, with its own books and the person as organization member with an administrator profile.
  • Creates the client under that organization, with its own books, and the person as its owner member.
  • Creates the built-in administrator and read only profiles of the client space and assigns the administrator profile to the person as default profile.
  • Invalidates the sign-up token and sends an email verification link (valid 1 hour); the person cannot sign in until the address is verified.
Part of Sign up and sign in.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
token
string
required

Sign-up token received in the email sent by check-email. It must have been issued for the same email address as this request, must not be expired (1 day) and is invalidated once the account is created.

first_name
string
required

First name of the new person, 3 to 250 characters.

Required string length: 3 - 250
last_name
string
required

Last name of the new person, 3 to 250 characters.

Required string length: 3 - 250
email
string<email>
required

Email address of the new account. Must be valid, must not be used by any existing account and must be the address the token was issued for. The account cannot sign in until it is verified.

phone_number
string
required

Phone number of the new account, 3 to 30 characters. Must not be used by any existing account.

Required string length: 3 - 30
password
string
required

Password of the new account: at least 8 characters with lower case, upper case, a digit and a symbol.

organization
object

New organization created for the client account.

client
object

Client account created with the person as its owner.

Response

detail
boolean
required

Always true when the account was created.