/

Browse the help center

User sign-up

Registers a new user, always with the NETWORK role.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/{key}/{hash}/{timestamp}.do

Registers a new user, always with the NETWORK role. This endpoint is similar to /register-user but is specifically designed for network-level sign-ups where the role is not user-selectable. Authentication uses the same public/private key mechanism: 'key' must match the network's public key, 'hash' must equal MD5(username + password + email + privateKey + timestamp), and the timestamp must be within 5 minutes. On success, the user is created (activated automatically when the role's permissions allow it), sign-up notifications are sent, and the response includes the assigned 'username' and tracking user ID if applicable.

Path Params

key string required

The network's public key, as set in its white-label settings.

abc123publickey

hash string required

Data integrity hash, computed as MD5(username + password + email + privateKey + timestamp), where privateKey is the network's private key. Verifies request authenticity and data integrity.

d41d8cd98f00b204e9800998ecf8427e

timestamp integer required

UNIX timestamp in milliseconds. Must be within 5 minutes of server time to prevent replay attacks.

1700000000000

Form Params

role string

User role type (ADMIN, ADVERTISER, PUBLISHER, NETWORK)

ADVERTISER

aclRole integer

ACL role defining user permissions — ID of the acl role

3

accountUIStyle string

UI layout style preference (TREES, GRIDS)

TREES

active boolean

Whether the user account is active

true

additionalRecipients string

Comma-separated list of additional notification email recipients

alerts@example.com,manager@example.com

additionalRecipientsPresent boolean

Whether additional email recipients are configured for notifications

true

adsHost string

Custom ad serving domain for this user

ads.example.com

advancedAnalyticsView string

Advanced analytics view mode (SIMPLE, EXTENDED, UNIQUE)

SIMPLE

campaignSetupMasked boolean

Mask campaign setup details in the UI

true

comments string

Internal notes and comments about the user

VIP client, priority support

compactMode boolean

Compact UI density preference; null means the client keeps its own default

false

company string

Company name

Acme Corp

country string

Two-letter country code (ISO 3166-1 alpha-2)

US

darkTheme boolean

Dark color theme preference; null means the client keeps its own default

false

email string

User email address (must be unique)

user@example.com

firstName string

First name

John

hideReferralDetails boolean

Hide referral details from the user's dashboard

true

lastName string

User's last (family) name

Smith

locale string

User preferred UI locale/language (BCP-47 tag); when empty, the network's default language applies, then English

en

owner integer

Parent/owner user (for sub-accounts) — ID of the user

500

password string

User password (8-64 characters)

s3cur3P@ss

paymentsAccountData string

Payment account data (bank/PayPal details as JSON)

{"paypal":"payments@example.com"}

permissions array<string>

User-level permission overrides

MANAGE_BANNERS,MANAGE_CAMPAIGNS

phone string

Phone number

+1234567890

publisherCategories string

Publisher category IDs (transient, comma-separated)

10,20,35

receiveNewsletter boolean

Opt in to receive newsletter emails

true

receiveNotificationsByEmail boolean

Receive system notifications by email

true

referer string

Referrer URL that brought the user to sign up

https://partner-site.com/signup

referralId integer

Referral user ID if this user was referred by another user

42

referralShareEnabled boolean

Whether referral revenue sharing is enabled for this user

true

referredClientStatus string

Referred client status tracking the referral lifecycle

UNDER_REVIEW

state string

State or province

California

tracking.campaign string

Campaign tracking parameter (UTM campaign name)

spring_sale

tracking.page string

Landing page tracking parameter

/pricing

tracking.term string

Search term tracking parameter (UTM term)

ad+server

userTemplates array<integer>

Notification email templates assigned to this user — IDs of the notification template entities, comma-separated or as repeated parameters

1,2,5

username string

john_doe

websiteUrl string

Website URL

https://www.example.com

Responses

200

User signed up successfully (includes 'result' and 'username') or validation errors returned

400

Bad request — invalid or missing parameters

401

Authentication error — the key does not match the network's public key, or the hash does not match

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'email=user@example.com' \
  --data-urlencode 'password=s3cur3P@ss' \
  --data-urlencode 'username=john_doe' \
  --data-urlencode 'role=ADVERTISER' \
  --data-urlencode 'aclRole=3' \
  --data-urlencode 'accountUIStyle=TREES'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do", data={"email": "user@example.com", "password": "s3cur3P@ss", "username": "john_doe", "role": "ADVERTISER", "aclRole": "3", "accountUIStyle": "TREES"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"email":"user@example.com","password":"s3cur3P@ss","username":"john_doe","role":"ADVERTISER","aclRole":"3","accountUIStyle":"TREES"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do"))
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("email=user%40example.com&password=s3cur3P%40ss&username=john_doe&role=ADVERTISER&aclRole=3&accountUIStyle=TREES"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["email"] = "user@example.com", ["password"] = "s3cur3P@ss", ["username"] = "john_doe", ["role"] = "ADVERTISER", ["aclRole"] = "3", ["accountUIStyle"] = "TREES" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do", strings.NewReader(`email=user%40example.com&password=s3cur3P%40ss&username=john_doe&role=ADVERTISER&aclRole=3&accountUIStyle=TREES`))
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'email=user%40example.com&password=s3cur3P%40ss&username=john_doe&role=ADVERTISER&aclRole=3&accountUIStyle=TREES');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/user-sign-up/abc123publickey/d41d8cd98f00b204e9800998ecf8427e/1700000000000.do")
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('email' => "user@example.com", 'password' => "s3cur3P@ss", 'username' => "john_doe", 'role' => "ADVERTISER", 'aclRole' => "3", 'accountUIStyle' => "TREES")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body