api-docs-icon

Create New Account

POST
/ api/ v1/ account

A new account will be created with a unique account id, associated with the requester's user id as the parent id.

A successful return will contain the API key for this account along with the user id of the new account. These should both be stored on your platform for future calls on behalf of this account. That API key should be used to make subsequent calls for resources on this account

Note:

username must be unique and not in use.

password must be at least 8 characters long and include at least 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character.

object
first_name
string
required

The first name of the account holder.

Example:
Thomas
last_name
string
required

The last name of the account holder.

Example:
Anderson
password
string
required

The password associated with the account. Must follow password guidelines.

Example:
wh1tera88!t
username
string
required

The username associated with the account.

Example:
choi
address_city
string
nullable

The city associated with the account's address.

Example:
New York
address_state
string
nullable

The state associated with the account's address.

Example:
NY
address_street
string
nullable

The street address associated with the account.

Example:
36 Pipers Row
address_zip
string
nullable

The zip code associated with the account's address.

Example:
10001
company
string
nullable

The company name associated with the account.

Example:
Metacortex
created_date
string
nullable
email_address
string
nullable

The email address associated with the account.

Example:
tanderson@metacortex.net
phone
string
nullable

The phone number associated with the account.

Example:
888-574-7346

Response

application/json
object
account_id
string
nullable

The unique account identifier.

Example:
10142067
api_key
string
nullable

The API key associated with the newly created account.

Example:
375EE04C-432E-4d6A-943B-1B97FDD7FED7
created_date
string (date-time)

The date and time when the account was created.

Example:
1999-02-19T12:00:00.00:00

Code Examples

Response