Skip to main content
GET
/
api
/
v1
/
credentials
curl --request GET \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/credentials?corporation_id=550e8400-e29b-41d4-a716-446655440000&extend=PORTAL_DETAILS' \
  --header 'Authorization: Bearer <your_token>'

{
  "message": "Successfully listed credentials.",
  "data": {
    "credentials": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "corporation_id": "550e8400-e29b-41d4-a716-446655440000",
        "portal_id": "PORTAL_CA_CDTFA",
        "credential_type": "INDIRECT_TAX_REGISTRATION",
        "is_custom": false,
        "name": "California CDTFA Portal",
        "status": "ACTIVE",
        "blocks": [
          {
            "id": "block-uuid-1",
            "block_key": "username",
            "block_label": "Username",
            "block_type": "String"
          },
          {
            "id": "block-uuid-2",
            "block_key": "password",
            "block_label": "Password",
            "block_type": "SecureString"
          }
        ],
        "portal_details": {
          "portal_id": "PORTAL_CA_CDTFA",
          "portal_name": "California Department of Tax and Fee Administration",
          "portal_url": "https://onlineservices.cdtfa.ca.gov",
          "country": "US",
          "state_or_province": "CA"
        },
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      }
    ],
    "count": 1
  }
}
Retrieve all credentials belonging to a corporation. Optionally filter by portal IDs and include inactive credentials.

​
Query parameters

​
corporation_id
string
required
The unique identifier (UUID) for the corporation.
​
portal_ids
string
Comma-separated list of portal IDs to filter by.Example: PORTAL_CA_CDTFA,PORTAL_TX_CPTD
​
include_inactive
string
Set to true to include expired credentials. Defaults to false.
​
extend
string
Set to PORTAL_DETAILS to include portal name, URL, and jurisdiction information in the response.
curl --request GET \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/credentials?corporation_id=550e8400-e29b-41d4-a716-446655440000&extend=PORTAL_DETAILS' \
  --header 'Authorization: Bearer <your_token>'

{
  "message": "Successfully listed credentials.",
  "data": {
    "credentials": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "corporation_id": "550e8400-e29b-41d4-a716-446655440000",
        "portal_id": "PORTAL_CA_CDTFA",
        "credential_type": "INDIRECT_TAX_REGISTRATION",
        "is_custom": false,
        "name": "California CDTFA Portal",
        "status": "ACTIVE",
        "blocks": [
          {
            "id": "block-uuid-1",
            "block_key": "username",
            "block_label": "Username",
            "block_type": "String"
          },
          {
            "id": "block-uuid-2",
            "block_key": "password",
            "block_label": "Password",
            "block_type": "SecureString"
          }
        ],
        "portal_details": {
          "portal_id": "PORTAL_CA_CDTFA",
          "portal_name": "California Department of Tax and Fee Administration",
          "portal_url": "https://onlineservices.cdtfa.ca.gov",
          "country": "US",
          "state_or_province": "CA"
        },
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      }
    ],
    "count": 1
  }
}
Block values for SecureString types are not returned in list responses. Use the Get Credential endpoint to retrieve a specific credential with its values.