Skip to main content

​
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

​
Block types

​
Credential statuses

​
Workflow

1

Get portal requirements

Use the Portal Fields endpoint to see what credential fields a portal requires.
2

Create a credential

Use the Create Credential endpoint to store the portal login details.
3

Link to a registration

Pass the credential_id when creating or updating a V2 registration.

​
API endpoints

​
Extending list responses

When listing credentials, you can include additional portal details by passing extend=PORTAL_DETAILS as a query parameter. This adds the portal name, URL, and jurisdiction information to each credential in the response.