> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ontra

> How to set up the Ontra connector, plus the actions that are available.

![Ontra](https://stackone-logos.com/api/ontra/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/ontra/changelog.md)

[70 actions](#actions) · 1 auth method

Legal
Contract Lifecycle Management

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/ontra/guides/connector-profile/oauth-2-0.md)
>
> Machine-to-machine access using an Ontra API client. Production requires mutual TLS (mTLS) with a self-signed certificat...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/ontra/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

70 actions

ActionDescription

List Accounts`ontra_list_accounts`

Retrieves a paginated list of accounts.

Get Account`ontra_get_account`

Retrieves a single account by id.

List Contractual Relationships`ontra_list_contractual_relationships`

Retrieves a paginated list of all contractual relationships.

Get Contractual Relationship`ontra_get_contractual_relationship`

Retrieves a single contractual relationship by id.

Get Contractual Relationship Counterparty`ontra_get_contractual_relationship_counterparty`

Retrieves the contractual relationship's counterparty.

Get Contractual Relationship Party`ontra_get_contractual_relationship_party`

Retrieves the contractual relationship's party.

Get Contractual Relationship Relationship Type`ontra_get_contractual_relationship_relationship_type`

Retrieves the contractual relationship's relationship type.

Create Contractual Relationship`ontra_create_contractual_relationship`

Creates a new contractual relationship.

Update Contractual Relationship`ontra_update_contractual_relationship`

Updates an contractual relationship.

Delete Contractual Relationship`ontra_delete_contractual_relationship`

Deletes a single contractual relationships by id.

List Contractual Relationship Types`ontra_list_contractual_relationship_types`

Retrieves a paginated list of all contractual relationship types.

List Currencies`ontra_list_currencies`

Retrieves a paginated list of currencies.

List Entities`ontra_list_entities`

Retrieves a paginated list of entities, e.g. a list of Funds in Insight.

Get Entity`ontra_get_entity`

Retrieves a single entity by id.

Get Entity Currency`ontra_get_entity_currency`

Retrieves the entity's default currency.

Get Entity Entity Type`ontra_get_entity_entity_type`

Retrieves the entity's type, e.g. Limited Liability Company.

List Entity Holding Relationships`ontra_list_entity_holding_relationships`

Retrieves the entity's holdings.

Get Entity Jurisdiction`ontra_get_entity_jurisdiction`

Retrieves the entity's jurisdiction.

List Entity Owner Relationships`ontra_list_entity_owner_relationships`

Retrieves the entity's owners.

List Purposes For Entity`ontra_list_purposes_for_entity`

Retrieves the entity's purposes, e.g. General Partner, Co-investment Vehicle, etc.

List Registrations For Entity`ontra_list_registrations_for_entity`

Retrieves the entity's registrations.

List Entity Tax Identifiers`ontra_list_entity_tax_identifiers`

Retrieves the entity's tax identifiers.

Get Entity Tax Treatment`ontra_get_entity_tax_treatment`

Retrieves the entity's tax treatment.

Create Entity`ontra_create_entity`

Creates a new entity, e.g. a Fund in Insight.

Update Entity`ontra_update_entity`

Updates an entity.

Delete Entity`ontra_delete_entity`

Deletes a single entity by id.

List Entity Types`ontra_list_entity_types`

Retrieves a paginated list of entity types.

List Entity Purposes`ontra_list_entity_purposes`

Retrieves a paginated list of entity purposes.

List Entity Registrations`ontra_list_entity_registrations`

Retrieves a paginated list of entity registrations.

Get Entity Registration`ontra_get_entity_registration`

Retrieves a single entity registration by id.

Create Entity Registration`ontra_create_entity_registration`

Creates a new Entity Registration.

Update Entity Registration`ontra_update_entity_registration`

Updates an entity registration.

Delete Entity Registration`ontra_delete_entity_registration`

Deletes a single entity registration by id.

List External Entities`ontra_list_external_entities`

Retrieves a paginated list of external entities, e.g. a list of Legal Entity Names in Insight.

Get External Entity`ontra_get_external_entity`

Retrieves a single external entity by id.

List External Entity Holding Relationships`ontra_list_external_entity_holding_relationships`

Retrieves the external entity's holdings.

Get External Entity Jurisdiction`ontra_get_external_entity_jurisdiction`

Retrieves the external entity's jurisdiction.

Create External Entity`ontra_create_external_entity`

Creates a new external entity, e.g. a Legal Entity Name in Insight.

Update External Entity`ontra_update_external_entity`

Updates an external entity.

Delete External Entity`ontra_delete_external_entity`

Deletes a single external entity by id.

List Jurisdictions`ontra_list_jurisdictions`

Retrieves a paginated list of jurisdictions.

List Ownership Relationships`ontra_list_ownership_relationships`

Retrieves a paginated list of all ownership relationships.

Get Ownership Relationship`ontra_get_ownership_relationship`

Retrieves a single ownership relationship by id.

Get Ownership Relationship Currency`ontra_get_ownership_relationship_currency`

Retrieves the ownership relationship's currency.

Get Ownership Relationship Holding`ontra_get_ownership_relationship_holding`

Retrieves the ownership relationship's holding.

Get Ownership Relationship Owner`ontra_get_ownership_relationship_owner`

Retrieves the ownership relationship's owner.

Get Ownership Relationship Relationship Type`ontra_get_ownership_relationship_relationship_type`

Retrieves the ownership relationship's relationship type.

Create Ownership Relationship`ontra_create_ownership_relationship`

Creates a new ownership relationship.

Update Ownership Relationship`ontra_update_ownership_relationship`

Updates an ownership relationship.

Delete Ownership Relationship`ontra_delete_ownership_relationship`

Deletes a single ownership relationships by id.

List Ownership Relationship Types`ontra_list_ownership_relationship_types`

Retrieves a paginated list of all ownership relationship types.

List People`ontra_list_persons`

Retrieves a paginated list of person entities.

Get Person`ontra_get_person`

Retrieves a single person entity by id.

List Person Holding Relationships`ontra_list_person_holding_relationships`

Retrieves the person's holdings.

Create Person`ontra_create_person`

Creates a new person.

Update Person`ontra_update_person`

Updates a person.

Delete Person`ontra_delete_person`

Deletes a single person by id.

List Registered Agents`ontra_list_registered_agents`

Retrieves a paginated list of registered agents.

List Registration Authorities`ontra_list_registration_authorities`

Retrieves a paginated list of registration authorities.

List Tags`ontra_list_tags`

Retrieves a paginated list of tags.

Get Tag`ontra_get_tag`

Retrieves a single tag by id.

Create Tag`ontra_create_tag`

Creates a new Tag.

Update Tag`ontra_update_tag`

Updates a tag.

List Tax Identifiers`ontra_list_tax_identifiers`

Retrieves a paginated list of tax identifiers.

Get Tax Identifier`ontra_get_tax_identifier`

Retrieves a single tax identifier by id.

Create Tax Identifier`ontra_create_tax_identifier`

Creates a new Tax Identifier.

Update Tax Identifier`ontra_update_tax_identifier`

Updates a tax identifier.

Delete Tax Identifier`ontra_delete_tax_identifier`

Deletes a single tax identifier by id.

List Tax Identifier Types`ontra_list_tax_identifier_types`

Retrieves a paginated list of tax identifier types.

List Tax Treatments`ontra_list_tax_treatments`

Retrieves a paginated list of tax treatments.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.