GET
/
registrations
/
new-registration
/
fields
curl --request GET \
  --url https://base_url/api/v1/registrations/new-registration/fields \
  --header 'Authorization: Bearer <token>'
{
  "description": "Successfully fetched fields",
  "data": [
    {
      "stepTitle": "General Information",
      "steps": [
        {
          "title": "Primary Business Location",
          "subtitle": "What is the address of your primary business location?",
          "fields": [
            {
              "key": "corporation.primaryBusinessLocation.addressLine1",
              "question": "Line 1",
              "type": "text",
              "required": true,
              "previousValue": "1776 Main St."
            }
          ]
        }
      ]
    }
  ],
  "message": "Successfully calculated tax."
}

This endpoint returns a complex nested object which can be processed to generate a web form. The end user should fill out the web form to provide information necessary for Commenda to offer a new sales tax registration. See more details here.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
country
string
required

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

​
state
string
required

2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.

Example:

"CA"

Response

200
application/json
Get required information response.
​
description
string
Example:

"Successfully fetched fields"

​
data
object[]
​
message
string
Example:

"Successfully calculated tax."