> ## 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.

# Connect Availity with OAuth 2.0 – StackOne Hub

> Link a Availity account in the StackOne Hub using OAuth 2.0. End-user guide to authorize the integration and start using Availity actions.

> [!WARNING]
>
> Live data needs the Standard plan, which Availity approves only after your organization signs a contract with Availity. Remittance data also needs ERA enrollment for each payer and provider in Availity Essentials, starting from **More** > **Payer List**, and Availity has to add the Remittance Data API (BETA) to your app. It is not listed under **API Products**, so ask your Availity contact for it, or email [partnermanagement@availity.com](mailto:partnermanagement@availity.com), the address Availity gives for subscription requests. The AWS Availity Payer List is a separate product with its own request, API Key, Secret and scope, so connect it as a separate account if you request it.

## Get your Availity API Key, Secret and scope

Your API Key, Secret and scope come from your organization's own app on the Availity Developer Portal, once Availity approves a product plan for it. The Standard plan returns live payer data. The Demo plan returns fixed sample answers, so it only tests the connection.

**1. Create a Developer Portal account**

Skip this step if you already have an account on the [Availity Developer Portal](https://developer.availity.com), which is a different site from Availity Essentials. Otherwise, select **Create Account** at the top right of the portal.

<ul>
  <li>On the page that opens, select **Create an account**.</li>
  <li>**Email**: your work email address</li>
  <li>**Name**: your first name</li>
  <li>**Family Name**: your last name</li>
  <li>Complete the sign-up the portal walks you through.</li>
</ul>

**2. Create or join your organization**

Sign in to the [Availity Developer Portal](https://developer.availity.com) and open your username at the top right > **My Dashboard** > **My Org/Users**.

<ul>
  <li>**New organization:** Select **Create an Organization**, enter the **Organization Name**, and select **Create Organization**.</li>
  <li>**Existing organization:** Ask your organization admin to add you to the organization through an Availity support ticket. Your organization's apps show under **My Apps** once you are added.</li>
</ul>

**3. Create the app**

Select **My Apps** in the menu bar.

<ul>
  <li>Select **Create a New App**.</li>
  <li>Enter the application details the form asks for. Apps can't be edited after they are created.</li>
  <li>Select **Create App**.</li>
</ul>

**4. Choose the product plan**

Select **API Products** in the menu bar.

<ul>
  <li>Select **More Info** on **Healthcare HIPAA Transactions** for live data, or on **Healthcare HIPAA Transactions Demo** for test data.</li>
  <li>Select **Access This Product**.</li>
  <li>Select **Access with this Plan** under **Standard** for live data, or under **Demo** for test data.</li>
</ul>

**5. Submit the request**

Select **Go to cart** in the notification that appears.

<ul>
  <li>Check that the **Selected Plan** is the plan you chose.</li>
  <li>In **Select an App**, select **Existing App**.</li>
  <li>Select the app you created.</li>
  <li>Select **Submit Request**.</li>
  <li>**Live data:** Email [partnermanagement@availity.com](mailto:partnermanagement@availity.com), or use [Contact Sales](https://www.availity.com/contact-sales/), to start the contract. Availity emails you once it has verified the contract and approved the request.</li>
  <li>**Test data:** Availity approves the request straight away.</li>
</ul>

**6. Copy the credentials**

Open **My Apps**. Availity issues each approved product its own API Key, Secret and scope, so a move from Demo to Standard means copying the new ones across.

<ul>
  <li>Select your app.</li>
  <li>Open **Approved Access**.</li>
  <li>Expand **Client info** for the product you requested.</li>
  <li>Copy the **API KEY** across with the copy icon at the end of its row.</li>
  <li>Copy the **SECRET** across.</li>
  <li>Select **View client type info**.</li>
  <li>Copy every **SCOPE PERMISSION** name across, on one line with a single space between them. Availity sets these names for each product, so copy them exactly.</li>
  <li>Format: every scope name, separated by one space</li>
  <li>Example: if **SCOPE PERMISSION** lists `healthcare-hipaa-transactions` and `healthcare-hipaa-transactions-standard`, the scope is `healthcare-hipaa-transactions healthcare-hipaa-transactions-standard`</li>
</ul>

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

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

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


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