Skip to main content
POST
Create account

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:

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.

Body

application/json
userName
string
required
eMail
string
required
phoneNr
string
required
password
string
required
apiKey
string
required
nonce
string
required
signature
string
required
seconds
integer
required
language
string
required

Response

200 - application/json

Success

created
string
required
updated
string
required
enabled
boolean
required
canRelay
boolean
required
jwt
string
required
expires
string
required
eMailCodeSent
boolean
required
phoneNrCodeSent
boolean
required