Skip to main content

How to set up Arch / Addepar Integration - Onboarding

This guide walks through linking your Arch account to your Addepar account in order for updates to be pushed from Arch to Addepar via API

Updated over 9 months ago

Setup

Onboarding with Arch will be led by your dedicated representative(s). Once you've completed onboarding your alternative investments to Arch, setting up the integration to Addepar consists of five steps:

  1. Create a group for Arch Accounts

  2. Contact Addepar Support

  3. Create Service Credential/Integration User for Arch

  4. Send Login Credentials to Arch

  5. Arch integrates investments between platforms

Step 1: Create a Group for Arch Accounts First, you'll create a group for all accounts and investments that will be managed and updated by Arch. (Recommended but not required)

  1. Create a group called "Arch Accounts”.

  2. Add all applicable accounts and investments to the group.

Note: You will need to maintain this group’s membership on an ongoing basis if you wish to add/remove accounts from your Arch service.

Step 2: Contact Addepar Support Once you have a group made for Arch Accounts, as well as to add a few items specific to the Arch integration.

  1. Request the custom attributes "Managed in Arch" and "Max Trade Date” be added.

  2. Request the personal view, "Arch - Holding Detail,” be added.

  3. Request that the @archdocuments.com domain be whitelisted.

  4. The Addepar Support Team will add the custom attributes to your firm and confirm that you can add a user.

Setting up custom attributes: For all applicable positions, set the "Managed in Arch" custom attribute to Yes.

Note: "Arch - Holding Detail" is a personal view for the service credential created for the integration.

Step 3: Create a Service Credential/Integration User for Arch

Next, you’ll create an integration user in Addepar that’s dedicated to the Arch integration. You can follow the steps to create a service credential, with the specifications below:

  1. Arch will provide you with the email to add for their user, ending in @archdocuments.com

Create an integration-specific user in Addepar

For integrations set up at the firm-level or integrations using an API key, we recommend creating an integration-specific user account and email address for the setup. This helps avoid disruptions to the integration.

Create the user

  1. Go to Firm Administration > Users > Create User.

  2. Name the user after the integration and fill in the user details. For example, the name might be 'Arch' and the email address 'firm.name@archdocuments.com.'

  3. Check the box to include the login information in the welcome email and create the user.

Set user permissions

  1. Set the user permissions for this integration. Make sure to enable API key access.

    1. Enable the below permissions for the Arch Integration User:

      1. Analysis Tool:

        1. Firm views: View-only

        2. Portal views: View-only

      2. Transactions:

        1. Transaction firm views: View-only

        2. Transactions: Create, edit, and delete access

    2. API Key: on

      1. This allows Arch to generate an API key to send transactions through

    3. Permission the user with the Arch Accounts group you made in Step 1

Step 4: Send login credentials to Arch

Your Arch representative will receive the login activation and will create an API Key to complete your integration’s technical setup.

If you prefer for Arch not to have a login, you can create an API key independently for this user and generate the API Key and Secret via the Firm Administration tab. Send this along with your Firm ID to your Arch representative.

Create an API key and secret in Addepar

An API key and secret are two alphanumeric codes used to authorize the transfer of data. Signed in as the user created for the integration setup, create an API key for this integration.

Note: Set the API access user permission to create API keys.

  1. Go to Firm Administration > API Access Key

  2. Click the '+' plus icon in the upper right-hand corner of the table.

  3. Give the key a name. We recommend naming it after the application or purpose you're using it for.

  4. Securely store the API Key and Secret. Once you click 'Done,' the secret will no longer appear, so you need to save it now.

  5. Click Done.

Step 5: Arch integrates investments between platforms

Your Arch representative will use the credentials you created to access the Entity IDs and Owner IDs for your investments and map them to Arch’s onboarded investments. This process will also apply to any new investments created going forward.

Note: The mapping process can be worked into your initial Arch onboarding if you provide investment Entity IDs and Owner IDs from the start.

Contact support

For questions about creating the API Key and secret, contact Addepar Support by using the in-app contact support tool or by calling the support line, 1(855)464-6268 ext. 2.

For questions about the integration, contact your Arch representative or team at operations@arch.co.

Related Articles
Addepar Integration Page
Did this answer your question?