Consents
Consent links Your Platform to Your Customer's Accounting System so you can access their data through API.1.
What is Consent?
Consent is the link between Your Customer in Your Platform and the connection to their Accounting System through API.1.
You create a Consent (and generate a Consent ID) which you use to invite Your Customer to connect their Accounting System, and then connect to API.1 to fetch their data and use it in Your Platform. For how consent is managed over time (keeping it active, purging, and retention), see Consent Lifecycle.
Managing Consents in the Client Portal
In the Client Portal you can view and manage all Consents for your Client. Switch between Development and Production to see Consents for each environment.
List Consents
The Consents view shows all Consents created for your Client. For each Consent you can see:
Name – The label you gave the Consent (you can change this).
Created date – When the Consent was created.
Status – Created, Accepted, Revoked, or Inactive (see Consent Status).
Connected system – The Accounting System Your Customer connected, once they have completed the Onboarding Flow.
Use search and filter to find Consents by name, status, or other criteria.
Rename Consent
You can edit a Consent's name at any time. This is for your own use so you can identify it easily (e.g. which of Your Customers or which use case it relates to). Renaming does not change the Consent ID or affect API.1 access.
Revoke Consent
Revoking a Consent immediately removes access via the customer-granted connection. You can no longer call the Accounting API for that Consent ID. Use Revoke when you need to stop using a Consent but may want to keep a record of it. A Revoked Consent is removed from the system after 180 days.
Delete Consent
Deleting a Consent removes it from the Client Portal immediately and completely. The Consent is no longer visible and cannot be restored. You cannot access data via API.1 for that Consent. Use Delete when you want to remove the Consent record permanently (e.g. for compliance or cleanup). Your Customer would need to go through the Onboarding Flow again with a new Consent if you need to restore access.
Last updated
Was this helpful?
