Child Accounts — Provisioning via API

Overview

This page documents the POST Child Accounts API endpoint, which allows an authenticated parent customer to provision a fully usable child customer account in a single atomic operation. The parent–child relationship is derived from authentication context, no parent ID is required in the request payload.

Endpoint: POST https://websvcs.quikforms.com/rest/accounts/v1000/childaccounts

Swagger page: https://websvcs.quikforms.com/rest/accounts/v1000/swagger/index.html


Solution Context

Child accounts are a core concept in the Quik! platform hierarchy. A parent account can create and manage one or more child accounts, each operating as a distinct account while rolling up to the parent for reporting and billing.

Reasons to use child accounts:

1. To segregate users, teams, or customers from one another

2. To enable users, teams, or customers to have their own settings (e.g. form bundles, form subscriptions, private forms)

3. To roll up child accounts into a single report for usage and billing purposes

4. To push parent account settings downward to child accounts (e.g. form bundles, e-sign settings, field validations)

5. For partners and resellers offering Quik! to their own customers — child accounts are the required and recommended setup


Security Scope

The parent–child relationship is established automatically from the authentication context.

⚠️ Passwords are never returned in any API response.


Sample JSON

{
  "companyName": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "useSameAddressAsParent": true,
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "stateId": 0,
    "zip": "string",
    "countryId": 0
  },
  "phone": "string",
  "phoneExtension": "string",
  "email": "string",
  "password": "string"
}

StateId and CountryId can be found in the table below:

Troubleshooting - Error Codes

HTTP Code

Meaning

Recommended Action

400

Invalid or missing required fields

Review request payload against the required fields list. Ensure all fields including nested address fields are present and valid.

401

Authentication failure

Confirm the caller is authenticated as a valid parent customer. Check credentials and token validity.

409

Email conflict

The supplied email address is already associated with an existing account. Use a unique email address.

500

Internal server error

Retry the request. If the issue persists, escalate to engineering with request details and timestamp.


Required Request Fields

Field

Type

Notes

companyName

string

Name of the child account company

firstName

string

Admin user first name

lastName

string

Admin user last name

email

string

Must be unique system-wide; becomes the adminUsername

password

string

Used for both Master + Admin credentials; never returned in response

phone

string

title

string

Admin user job title

address.line1

string

address.city

string

address.stateId

string

State identifier

address.zip

string

address.countryId

string

Country identifier

Success Response

{
  "childCustomerId": "<string>",
  "adminUsername": "<email>"
}


StateID

The following StateIDs should be used to represent the appropriate state or territory.

StateID

StateCode

StateName

1

AK

Alaska

2

AL

Alabama

3

AP

Military code

4

AR

Arkansas

5

AZ

Arizona

6

CA

California

7

CO

Colorado

8

CT

Connecticut

9

DC

Washington DC

10

DE

Delaware

11

FL

Florida

12

GA

Georgia

13

GU

Guam

14

HI

Hawaii

15

IA

Iowa

16

ID

Idaho

17

IL

Illinois

18

IN

Indiana

19

KS

Kansas

20

KY

Kentucky

21

LA

Louisiana

22

MA

Massachusetts

23

MD

Maryland

24

ME

Maine

25

MI

Michigan

26

MN

Minnesota

27

MO

Missouri

28

MS

Mississippi

29

MT

Montana

30

NC

North Carolina

31

ND

North Dakota

32

NE

Nebraska

33

NH

New Hampshire

34

NJ

New Jersey

35

NM

New Mexico

36

NV

Nevada

37

NY

New York

38

OH

Ohio

39

OK

Oklahoma

40

OR

Oregon

41

PA

Pennsylvania

42

PR

Puerto Rico

43

RI

Rhode Island

44

SC

South Carolina

45

SD

South Dakota

46

TN

Tennessee

47

TX

Texas

48

UT

Utah

49

VA

Virginia

50

VT

Vermont

51

WA

Washington

52

WI

Wisconsin

53

WV

West Virginia

54

WY

Wyoming

55

VI

Virgin Islands

56

AB

Alberta

58

BC

British Columbia

59

MB

Manitoba

60

NB

New Brunswick

61

NL

Newfoundland and Labrador

62

NS

Nova Scotia

63

NT

Northwest Territories

64

NU

Nunavut

65

ON

Ontario

66

PE

Prince Edward Island

67

QC

Quebec

68

SK

Saskatchewan

69

YT[A]

Yukon

CountryID

The following countries can be used with this web service.

CountryID

Country

1

United States of America

2

Canada