Create account
curl --request POST \
--url https://{host}/Agent/Account/Create \
--header 'Content-Type: application/json' \
--header 'Referer: <referer>' \
--data '
{
"userName": "alice",
"eMail": "alice@example.com",
"phoneNr": "+46700000000",
"password": "<ACCOUNT_PASSWORD>",
"apiKey": "<AGENT_API_KEY>",
"nonce": "random-unique-string-at-least-32-chars",
"signature": "base64-hmac",
"seconds": 3600,
"language": "en"
}
'import requests
url = "https://{host}/Agent/Account/Create"
payload = {
"userName": "alice",
"eMail": "alice@example.com",
"phoneNr": "+46700000000",
"password": "<ACCOUNT_PASSWORD>",
"apiKey": "<AGENT_API_KEY>",
"nonce": "random-unique-string-at-least-32-chars",
"signature": "base64-hmac",
"seconds": 3600,
"language": "en"
}
headers = {
"Referer": "<referer>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Referer: '<referer>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userName: 'alice',
eMail: 'alice@example.com',
phoneNr: '+46700000000',
password: '<ACCOUNT_PASSWORD>',
apiKey: '<AGENT_API_KEY>',
nonce: 'random-unique-string-at-least-32-chars',
signature: 'base64-hmac',
seconds: 3600,
language: 'en'
})
};
fetch('https://{host}/Agent/Account/Create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/Agent/Account/Create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userName' => 'alice',
'eMail' => 'alice@example.com',
'phoneNr' => '+46700000000',
'password' => '<ACCOUNT_PASSWORD>',
'apiKey' => '<AGENT_API_KEY>',
'nonce' => 'random-unique-string-at-least-32-chars',
'signature' => 'base64-hmac',
'seconds' => 3600,
'language' => 'en'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Referer: <referer>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/Agent/Account/Create"
payload := strings.NewReader("{\n \"userName\": \"alice\",\n \"eMail\": \"alice@example.com\",\n \"phoneNr\": \"+46700000000\",\n \"password\": \"<ACCOUNT_PASSWORD>\",\n \"apiKey\": \"<AGENT_API_KEY>\",\n \"nonce\": \"random-unique-string-at-least-32-chars\",\n \"signature\": \"base64-hmac\",\n \"seconds\": 3600,\n \"language\": \"en\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Referer", "<referer>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/Agent/Account/Create")
.header("Referer", "<referer>")
.header("Content-Type", "application/json")
.body("{\n \"userName\": \"alice\",\n \"eMail\": \"alice@example.com\",\n \"phoneNr\": \"+46700000000\",\n \"password\": \"<ACCOUNT_PASSWORD>\",\n \"apiKey\": \"<AGENT_API_KEY>\",\n \"nonce\": \"random-unique-string-at-least-32-chars\",\n \"signature\": \"base64-hmac\",\n \"seconds\": 3600,\n \"language\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/Agent/Account/Create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Referer"] = '<referer>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userName\": \"alice\",\n \"eMail\": \"alice@example.com\",\n \"phoneNr\": \"+46700000000\",\n \"password\": \"<ACCOUNT_PASSWORD>\",\n \"apiKey\": \"<AGENT_API_KEY>\",\n \"nonce\": \"random-unique-string-at-least-32-chars\",\n \"signature\": \"base64-hmac\",\n \"seconds\": 3600,\n \"language\": \"en\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2024-08-02T10:22:11Z",
"updated": "2024-08-02T10:22:11Z",
"enabled": false,
"canRelay": true,
"jwt": "<JWT>",
"expires": "2024-08-02T11:22:11Z",
"eMailCodeSent": true,
"phoneNrCodeSent": false
}Accounts
Create account
Create a Neuron account and receive an initial JWT
POST
/
Agent
/
Account
/
Create
Create account
curl --request POST \
--url https://{host}/Agent/Account/Create \
--header 'Content-Type: application/json' \
--header 'Referer: <referer>' \
--data '
{
"userName": "alice",
"eMail": "alice@example.com",
"phoneNr": "+46700000000",
"password": "<ACCOUNT_PASSWORD>",
"apiKey": "<AGENT_API_KEY>",
"nonce": "random-unique-string-at-least-32-chars",
"signature": "base64-hmac",
"seconds": 3600,
"language": "en"
}
'import requests
url = "https://{host}/Agent/Account/Create"
payload = {
"userName": "alice",
"eMail": "alice@example.com",
"phoneNr": "+46700000000",
"password": "<ACCOUNT_PASSWORD>",
"apiKey": "<AGENT_API_KEY>",
"nonce": "random-unique-string-at-least-32-chars",
"signature": "base64-hmac",
"seconds": 3600,
"language": "en"
}
headers = {
"Referer": "<referer>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Referer: '<referer>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userName: 'alice',
eMail: 'alice@example.com',
phoneNr: '+46700000000',
password: '<ACCOUNT_PASSWORD>',
apiKey: '<AGENT_API_KEY>',
nonce: 'random-unique-string-at-least-32-chars',
signature: 'base64-hmac',
seconds: 3600,
language: 'en'
})
};
fetch('https://{host}/Agent/Account/Create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/Agent/Account/Create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userName' => 'alice',
'eMail' => 'alice@example.com',
'phoneNr' => '+46700000000',
'password' => '<ACCOUNT_PASSWORD>',
'apiKey' => '<AGENT_API_KEY>',
'nonce' => 'random-unique-string-at-least-32-chars',
'signature' => 'base64-hmac',
'seconds' => 3600,
'language' => 'en'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Referer: <referer>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/Agent/Account/Create"
payload := strings.NewReader("{\n \"userName\": \"alice\",\n \"eMail\": \"alice@example.com\",\n \"phoneNr\": \"+46700000000\",\n \"password\": \"<ACCOUNT_PASSWORD>\",\n \"apiKey\": \"<AGENT_API_KEY>\",\n \"nonce\": \"random-unique-string-at-least-32-chars\",\n \"signature\": \"base64-hmac\",\n \"seconds\": 3600,\n \"language\": \"en\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Referer", "<referer>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/Agent/Account/Create")
.header("Referer", "<referer>")
.header("Content-Type", "application/json")
.body("{\n \"userName\": \"alice\",\n \"eMail\": \"alice@example.com\",\n \"phoneNr\": \"+46700000000\",\n \"password\": \"<ACCOUNT_PASSWORD>\",\n \"apiKey\": \"<AGENT_API_KEY>\",\n \"nonce\": \"random-unique-string-at-least-32-chars\",\n \"signature\": \"base64-hmac\",\n \"seconds\": 3600,\n \"language\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/Agent/Account/Create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Referer"] = '<referer>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userName\": \"alice\",\n \"eMail\": \"alice@example.com\",\n \"phoneNr\": \"+46700000000\",\n \"password\": \"<ACCOUNT_PASSWORD>\",\n \"apiKey\": \"<AGENT_API_KEY>\",\n \"nonce\": \"random-unique-string-at-least-32-chars\",\n \"signature\": \"base64-hmac\",\n \"seconds\": 3600,\n \"language\": \"en\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2024-08-02T10:22:11Z",
"updated": "2024-08-02T10:22:11Z",
"enabled": false,
"canRelay": true,
"jwt": "<JWT>",
"expires": "2024-08-02T11:22:11Z",
"eMailCodeSent": true,
"phoneNrCodeSent": false
}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.
Headers
Your application's HTTPS URL, for example https://app.example.com/. Include this header on every Agent API request, including backend calls, login, and account creation. Browser clients must use a referrer policy that sends the application origin. See /neuron-api/api-basics#required-referer-header.
Body
application/json