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

{
  "data": {
    "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": "STRING",
            "required": true,
            "is_unique_per_registration": false,
            "helper_text": "Enter the username you use to log in to the CDTFA portal",
            "display_order": 1
          },
          {
            "credential_key": "password",
            "credential_name": "Password",
            "credential_type": "STRING",
            "required": true,
            "is_unique_per_registration": false,
            "display_order": 2
          }
        ]
      }
    ]
  }
}
Retrieve portal information and credential fields required for automated tax filing. Each jurisdiction has one or more tax portals where credentials are needed to file returns.
V2 portal fields are looked up by portal_id (from the Available Registrations response), not by registration_content_id as in V1.

​
Request body

​
portal_ids
array
required
Array of portal IDs to get fields for. Get these from the portal_ids field in the Available Registrations response.Minimum 1, maximum 100 items.Example: ["PORTAL_CA_CDTFA", "PORTAL_DE_ELSTER"]
curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/v2/content/portal-fields' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "portal_ids": ["PORTAL_CA_CDTFA"]
  }'

{
  "data": {
    "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": "STRING",
            "required": true,
            "is_unique_per_registration": false,
            "helper_text": "Enter the username you use to log in to the CDTFA portal",
            "display_order": 1
          },
          {
            "credential_key": "password",
            "credential_name": "Password",
            "credential_type": "STRING",
            "required": true,
            "is_unique_per_registration": false,
            "display_order": 2
          }
        ]
      }
    ]
  }
}

​
Credential field properties

FieldTypeDescription
credential_keystringField identifier used when storing credentials
credential_namestringHuman-readable label for the field
credential_typestringInput type (STRING, FILE, etc.)
requiredbooleanWhether the field must be provided
helper_textstringOptional hint text for UI display, explaining what to enter in this field
is_unique_per_registrationbooleanWhether each registration needs a unique value
regexstringValidation regex pattern (if applicable)
display_orderintegerSuggested display order for UI rendering