Get Portal Fields

curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "registration_content_ids": ["CCT_US_STATE_CEN_06_RST"]
    }
  }'

curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "registration_content_ids": ["CCT_US_STATE_CEN_06_RST", "CCT_US_STATE_CEN_48_RST"]
    }
  }'

{
  "filters": {
    "registration_content_ids": ["CCT_US_STATE_CEN_06_RST"]
  }
}

{
  "filters": {
    "registration_content_ids": [
      "CCT_US_STATE_CEN_06_RST",
      "CCT_US_STATE_CEN_48_RST",
      "CCT_US_STATE_CEN_36_RST"
    ]
  }
}

{
  "data": {
    "forms": [
      {
        "registration_content_id": "CCT_US_STATE_CEN_06_RST",
        "jurisdiction_id": "JUR_US_STATE_CA",
        "jurisdiction_name": "California",
        "tax_type": "RST",
        "portals": [
          {
            "portal_id": "PORTAL_CA_CDTFA",
            "portal_name": "California Department of Tax and Fee Administration",
            "portal_url": "https://onlineservices.cdtfa.ca.gov/",
            "credential_fields": [
              {
                "credential_key": "username",
                "credential_name": "Username",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 1
              },
              {
                "credential_key": "password",
                "credential_name": "Password",
                "credential_type": "password",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 2
              },
              {
                "credential_key": "security_question",
                "credential_name": "Security Question Answer",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 3
              }
            ]
          }
        ]
      },
      {
        "registration_content_id": "CCT_US_STATE_CEN_48_RST",
        "jurisdiction_id": "JUR_US_STATE_TX",
        "jurisdiction_name": "Texas",
        "tax_type": "RST",
        "portals": [
          {
            "portal_id": "PORTAL_TX_COMPTROLLER",
            "portal_name": "Texas Comptroller WebFile",
            "portal_url": "https://comptroller.texas.gov/taxes/file-pay/",
            "credential_fields": [
              {
                "credential_key": "taxpayer_number",
                "credential_name": "Taxpayer Number",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": true,
                "regex": "^[0-9]{11}$",
                "display_order": 1
              },
              {
                "credential_key": "webfile_number",
                "credential_name": "WebFile Number",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": true,
                "display_order": 2
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "message": "Invalid request.",
  "error": {
    "type": "CLIENT_INVALID_REQUEST_BODY",
    "title": "Missing required field",
    "detail": "filters.registration_content_ids is required",
    "status": 400,
    "instance": "/api/v1/registrations/content/portal-fields"
  }
}

POST

api

registrations

content

portal-fields

curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "registration_content_ids": ["CCT_US_STATE_CEN_06_RST"]
    }
  }'

curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "registration_content_ids": ["CCT_US_STATE_CEN_06_RST", "CCT_US_STATE_CEN_48_RST"]
    }
  }'

{
  "filters": {
    "registration_content_ids": ["CCT_US_STATE_CEN_06_RST"]
  }
}

{
  "filters": {
    "registration_content_ids": [
      "CCT_US_STATE_CEN_06_RST",
      "CCT_US_STATE_CEN_48_RST",
      "CCT_US_STATE_CEN_36_RST"
    ]
  }
}

{
  "data": {
    "forms": [
      {
        "registration_content_id": "CCT_US_STATE_CEN_06_RST",
        "jurisdiction_id": "JUR_US_STATE_CA",
        "jurisdiction_name": "California",
        "tax_type": "RST",
        "portals": [
          {
            "portal_id": "PORTAL_CA_CDTFA",
            "portal_name": "California Department of Tax and Fee Administration",
            "portal_url": "https://onlineservices.cdtfa.ca.gov/",
            "credential_fields": [
              {
                "credential_key": "username",
                "credential_name": "Username",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 1
              },
              {
                "credential_key": "password",
                "credential_name": "Password",
                "credential_type": "password",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 2
              },
              {
                "credential_key": "security_question",
                "credential_name": "Security Question Answer",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 3
              }
            ]
          }
        ]
      },
      {
        "registration_content_id": "CCT_US_STATE_CEN_48_RST",
        "jurisdiction_id": "JUR_US_STATE_TX",
        "jurisdiction_name": "Texas",
        "tax_type": "RST",
        "portals": [
          {
            "portal_id": "PORTAL_TX_COMPTROLLER",
            "portal_name": "Texas Comptroller WebFile",
            "portal_url": "https://comptroller.texas.gov/taxes/file-pay/",
            "credential_fields": [
              {
                "credential_key": "taxpayer_number",
                "credential_name": "Taxpayer Number",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": true,
                "regex": "^[0-9]{11}$",
                "display_order": 1
              },
              {
                "credential_key": "webfile_number",
                "credential_name": "WebFile Number",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": true,
                "display_order": 2
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "message": "Invalid request.",
  "error": {
    "type": "CLIENT_INVALID_REQUEST_BODY",
    "title": "Missing required field",
    "detail": "filters.registration_content_ids is required",
    "status": 400,
    "instance": "/api/v1/registrations/content/portal-fields"
  }
}

Retrieve the portal information and credential fields required for automated tax filing. Each state has one or more tax portals where credentials are needed to file returns.

Request Body

object

required

array

required

Array of registration content IDs to get portal fields for. Get these from the Registration Input Options endpoint.Example: ["CCT_US_STATE_CEN_06_RST", "CCT_US_STATE_CEN_48_RST"]

Response Fields

Field	Type	Description
`forms`	array	Portal requirements for each registration content
`forms[].registration_content_id`	string	The registration content ID
`forms[].jurisdiction_id`	string	The jurisdiction ID
`forms[].jurisdiction_name`	string	Human-readable jurisdiction name
`forms[].tax_type`	string	Tax type for this registration
`forms[].portals`	array	Available portals for this registration

Portal Object

Field	Type	Description
`portal_id`	string	Unique identifier for the portal (use in registration)
`portal_name`	string	Human-readable portal name
`portal_url`	string	URL to the state’s tax portal website
`credential_fields`	array	Required credential fields

Credential Field Object

Field	Type	Description
`credential_key`	string	Field identifier
`credential_name`	string	Human-readable field name
`credential_type`	string	Field type: `text`, `password`, `pin`, etc.
`required`	boolean	Whether the field is required
`is_unique_per_registration`	boolean	Whether each registration needs a unique value
`regex`	string	Validation regex pattern (if applicable)
`display_order`	integer	Suggested display order for UI

curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "registration_content_ids": ["CCT_US_STATE_CEN_06_RST"]
    }
  }'

curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "registration_content_ids": ["CCT_US_STATE_CEN_06_RST", "CCT_US_STATE_CEN_48_RST"]
    }
  }'

{
  "filters": {
    "registration_content_ids": ["CCT_US_STATE_CEN_06_RST"]
  }
}

{
  "filters": {
    "registration_content_ids": [
      "CCT_US_STATE_CEN_06_RST",
      "CCT_US_STATE_CEN_48_RST",
      "CCT_US_STATE_CEN_36_RST"
    ]
  }
}

{
  "data": {
    "forms": [
      {
        "registration_content_id": "CCT_US_STATE_CEN_06_RST",
        "jurisdiction_id": "JUR_US_STATE_CA",
        "jurisdiction_name": "California",
        "tax_type": "RST",
        "portals": [
          {
            "portal_id": "PORTAL_CA_CDTFA",
            "portal_name": "California Department of Tax and Fee Administration",
            "portal_url": "https://onlineservices.cdtfa.ca.gov/",
            "credential_fields": [
              {
                "credential_key": "username",
                "credential_name": "Username",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 1
              },
              {
                "credential_key": "password",
                "credential_name": "Password",
                "credential_type": "password",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 2
              },
              {
                "credential_key": "security_question",
                "credential_name": "Security Question Answer",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": false,
                "display_order": 3
              }
            ]
          }
        ]
      },
      {
        "registration_content_id": "CCT_US_STATE_CEN_48_RST",
        "jurisdiction_id": "JUR_US_STATE_TX",
        "jurisdiction_name": "Texas",
        "tax_type": "RST",
        "portals": [
          {
            "portal_id": "PORTAL_TX_COMPTROLLER",
            "portal_name": "Texas Comptroller WebFile",
            "portal_url": "https://comptroller.texas.gov/taxes/file-pay/",
            "credential_fields": [
              {
                "credential_key": "taxpayer_number",
                "credential_name": "Taxpayer Number",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": true,
                "regex": "^[0-9]{11}$",
                "display_order": 1
              },
              {
                "credential_key": "webfile_number",
                "credential_name": "WebFile Number",
                "credential_type": "text",
                "required": true,
                "is_unique_per_registration": true,
                "display_order": 2
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "message": "Invalid request.",
  "error": {
    "type": "CLIENT_INVALID_REQUEST_BODY",
    "title": "Missing required field",
    "detail": "filters.registration_content_ids is required",
    "status": 400,
    "instance": "/api/v1/registrations/content/portal-fields"
  }
}

Using Portal Information

Storing Credentials

Credentials are stored separately from registrations for security. The typical flow:

Collect credentials from the user based on credential_fields
Store credentials securely (via your credentials management system)
Reference the stored credentials via credential_id when updating the registration

Multiple Portals

Some registrations may have multiple portal options. Present all options to the user and use the selected portal_id when creating/updating the registration.

Credential Reuse

When is_unique_per_registration is false, the same credentials can be used across multiple registrations (common for multi-state sellers using a single account).

Next Steps

With the portal requirements understood, you can:

Build UI forms to collect credentials from sellers
Create registrations with the registration_content_id
Update registrations to add portal credentials
Request validation to enable automated filing

Registration Content Overview — Full content API workflow
Tax Registrations — Registration concepts and lifecycle

Get Started

Registrations

Registrations V2

Corporations

Tax Calculations

Transactions

Address Requirements

Registration Thresholds

Products

Customers

Exemption Certificates

Exemptions

Files

Credentials

Locations

Filings

Webhooks

Request Body

Response Fields

Portal Object

Credential Field Object

Using Portal Information

Storing Credentials

Multiple Portals

Credential Reuse

Next Steps

​Request Body

​Response Fields

​Portal Object

​Credential Field Object

​Using Portal Information

​Storing Credentials

​Multiple Portals

​Credential Reuse

​Next Steps

​Related

Request Body

Response Fields

Portal Object

Credential Field Object

Using Portal Information

Storing Credentials

Multiple Portals

Credential Reuse

Next Steps

Related