Create account

• Creates a new account and a user if the provided email does not exist on the system.
• Associates the user with the account with root privileges.
• Sends an email to the user to verify their email address if the email is not already verified on the system.
• A user can be a member of any number of accounts but they can be a root of at most one account.

POST /accounts

Create account

cURL

curl --request POST \
  --url https://api.quiva.ai/accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "acme",
  "root_first_name": "John",
  "root_last_name": "Doe",
  "root_email": "[e-mail]",
  "password": "SecureP@ssw0rd!",
  "country": "US",
  "company_name": "ACME Corporation",
  "address": "123 Main St, Anytown, USA",
  "website": "https://acme.com",
  "phone_number": "[phone]"
}
'

200

{
  "data": {
    "email_confirmed": false,
    "description": "This flag confirms whether a new or an existing user is the root of the newly created account."
  }
}

Body

application/json

name · string · required

Account name that members of the account will be using when signing in. It is case-insensitive. Heading and trailing spaces are trimmed

root_email · string<email> · required

Root user email. A user is not allowed to use the same email as a root email for multiple accounts.

password · string<password> · required

Root user password. It has to be a new password if the user is new to the system. If the user exists, they must provide their current password. New password requirements:

• Minimum length: 8 characters
• Must contain at least one uppercase letter
• Must contain at least one lowercase letter
• Must contain at least one digit (number)
• Must contain at least one special character (punctuation or symbol)
• Maximum length: 99 characters

root_first_name · string

Root user first name

root_last_name · string

Root user last name

country · string

Country

company_name · string

Company name

address · string

Company address

website · string

Company website

phone_number · string

Company phone number

Response

200

application/json

Account created successfully

data · object · required

Show child attributes