Skip to main content
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, 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, which is a different site from Availity Essentials. Otherwise, select Create Account at the top right of the portal.

  • On the page that opens, select Create an account.
  • Email: your work email address
  • Name: your first name
  • Family Name: your last name
  • Complete the sign-up the portal walks you through.
2

Create or join your organization

Sign in to the Availity Developer Portal and open your username at the top right > My Dashboard > My Org/Users.

  • New organization: Select Create an Organization, enter the Organization Name, and select Create Organization.
  • 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.
3

Create the app

Select My Apps in the menu bar.

  • Select Create a New App.
  • Enter the application details the form asks for. Apps can’t be edited after they are created.
  • Select Create App.
4

Choose the product plan

Select API Products in the menu bar.

  • Select More Info on Healthcare HIPAA Transactions for live data, or on Healthcare HIPAA Transactions Demo for test data.
  • Select Access This Product.
  • Select Access with this Plan under Standard for live data, or under Demo for test data.
5

Submit the request

Select Go to cart in the notification that appears.

  • Check that the Selected Plan is the plan you chose.
  • In Select an App, select Existing App.
  • Select the app you created.
  • Select Submit Request.
  • Live data: Email partnermanagement@availity.com, or use Contact Sales, to start the contract. Availity emails you once it has verified the contract and approved the request.
  • Test data: Availity approves the request straight away.
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.

  • Select your app.
  • Open Approved Access.
  • Expand Client info for the product you requested.
  • Copy the API KEY across with the copy icon at the end of its row.
  • Copy the SECRET across.
  • Select View client type info.
  • 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.
  • Format: every scope name, separated by one space
  • Example: if SCOPE PERMISSION lists healthcare-hipaa-transactions and healthcare-hipaa-transactions-standard, the scope is healthcare-hipaa-transactions healthcare-hipaa-transactions-standard
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.