Create account

Create or return an account for a domain.

POST /v0/accounts

Create account

cURL

curl --request POST \
  --url https://api.tryarchitect.com/v0/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "domain": "<string>",
  "name": "<string>"
}
'

200

{
  "accountId": "<string>",
  "domain": "<string>",
  "name": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "latestActivityAt": "<string>",
  "linkedPersons": [
    {
      "personId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "domain": "<string>",
      "slug": "<string>",
      "phoneNumber": "<string>",
      "linkedinProfileUrl": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Overview

Creates a new agent account and logs the user in. The account behaves like a regular XMPP account. New accounts are disabled until their email address is verified. Phone verification is optional if a phone number is provided.

Authentication

This endpoint requires an API key and secret. Sign the request with HMAC-SHA256 using the API secret as the key.

Signature message:

userName:host:eMail:password:apiKey:nonce

Notes

• Protect your API key and secret. They should only be used from secure back-end services.
• Each API key has a limit on how many accounts it can create.
• If you cannot protect secrets (for example, in a browser), use CreateWebForm.

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Body

application/json

domain · string · required

Canonical account domain

Minimum string length: 1

name · string

Required string length: 1 - 255

Response

200

application/json

Successful operation

accountId · string · required

Minimum string length: 1

Pattern: ^account_[a-z0-9]{26}$

domain · string · required

Canonical account domain

Minimum string length: 1

name · string | null · required

Required string length: 1 - 255

createdAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

updatedAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

latestActivityAt · string | null · required

Pattern: ^\+[1-9]\d{1,14}$

linkedPersons · object[] · required

Show child attributes