Skip to Help Center content

Step-by-step guide

Create an API application

Create an application and restrict it to the required companies and scopes.

Sensitive cap-table action

Verify permissions, source documents, amounts, dates, affected stakeholders, and the recovery path before changing recorded ownership.

In this article
  1. Create an application
  2. Access boundaries
  3. Verify the application before writes
  4. Review access over time

Create an application

Personal Data → Actions → Manage API access → Create application

  1. Give the application a recognizable name and identify its operator.
  2. Select only the companies the application is authorized to access.
  3. Select the minimum scopes required for its documented purpose.
  4. Create the application and copy the generated secret exactly once.
  5. Test read access before enabling any write or issuance workflow.

Access boundaries

A normal application can access only explicitly granted companies and companies it creates where supported. Platform-wide administration requires separately authorized Eqdeal administration access.

Scopes do not replace company access

The application needs both the required scope and access to the target company. Granting a write scope alone does not authorize every company.

Verify the application before writes

  1. Authenticate from a server-side environment without exposing the secret.
  2. List or read only the explicitly granted companies.
  3. Confirm that an unauthorized company remains unavailable.
  4. Inspect validation and preview responses before enabling a business-data change.
  5. Record the application owner and recovery procedure.

Review access over time

Remove companies and scopes that are no longer required, rotate secrets under the credential policy, and disable abandoned applications. An application should have a recognizable operator and documented purpose throughout its life.