Documentation Index
Fetch the complete documentation index at: https://docs.commenda.io/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Credentials API provides secure storage for login credentials to government tax portals. Credentials are used by Commenda to file tax returns on your behalf when managed filing is enabled on a registration. Each credential contains one or more blocks — structured key-value pairs that store individual fields like usernames, passwords, and account numbers.Credential types
| Type | Description |
|---|---|
INDIRECT_TAX_REGISTRATION | Credentials for a tax filing portal linked to a registration |
OTHER | General-purpose credentials |
Block types
| Type | Description |
|---|---|
String | Plain text value (usernames, account numbers) |
SecureString | Encrypted value (passwords, PINs) |
File | File attachment (certificates, keys) |
Credential statuses
| Status | Description |
|---|---|
ACTIVE | Credential is valid and in use |
EXPIRED | Credential has expired and needs renewal |
Workflow
Get portal requirements
Use the Portal Fields endpoint to see what credential fields a portal requires.
Create a credential
Use the Create Credential endpoint to store the portal login details.
API endpoints
| Endpoint | Method | Description |
|---|---|---|
/credentials | POST | Create a new credential |
/credentials | GET | List credentials for a corporation |
/credentials/{id} | GET | Get a single credential |
/credentials/{id} | POST | Update a credential |
/credentials/{id} | DELETE | Delete a credential |
Extending list responses
When listing credentials, you can include additional portal details by passingextend=PORTAL_DETAILS as a query parameter. This adds the portal name, URL, and jurisdiction information to each credential in the response.