RegistrationRequestParam object

This page describes the registration_request_param object, which contains the parameters used to create a new registration request.

Example JSON request

1 {
2   "state": "CA",
3   "email": "jane.smith@example.com",
4   "company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5   "company_name": "Acme Corporation",
6   "external_id": "ext-12345",
7   "tax_registration_types": ["sales_tax", "payroll_tax"],
8   "jurisdictions": ["state", "local"],
9   "redirect_uri": "https://example.com/registration/success",
10   "redirect_back_uri": "https://example.com/registration/back"
11 }

RegistrationRequestParam attributes

Attribute	Type	Description
`state`	string	US state abbreviation where registration is being requested. Required.
`email`	string (email)	Email address of the user completing the registration. Required.
`company_id`	string (uuid)	ID of an existing company to register. Use this or `company_name`.
`company_name`	string	Name of a new company to create and register. Use this or `company_id`.
`external_id`	string	External identifier for the company in your system.
`tax_registration_types`	array[string]	Types of tax registrations to request (for example, `sales_tax`, `payroll_tax`).
`jurisdictions`	array[string]	Tax jurisdictions to register in.
`redirect_uri`	string (uri)	URL to redirect to after successful registration completion.
`redirect_back_uri`	string (uri)	URL to redirect to if user navigates back.

State values

The state attribute accepts standard two-letter US state abbreviations:

AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY

Tax registration types

Common values for tax_registration_types:

Type	Description
`sales_tax`	Sales and use tax registration.
`payroll_tax`	Payroll and withholding tax registration.

Get a demo

Contact your account manager or contact sales to inquire about access.