Get Started

Welcome to the Availity Enterprise Development Portal where you can create applications using the Availity API

The following sections provide instructions for :

Creating an account
Adding a new Organization
Registering an application
Subscribing to an API product
Demo Subscription
Token Generation
Support Ticket

Create an Account

On the landing page, select Create account at the top right.
On the Sign In page, select Create an account again.
On the Sign Up page, complete all required fields, including Email, Name, Family Name, and Password (ensure it meets the password policy). Re-enter your password to confirm, then select Sign Up.
Enter the security code received via email and select Confirm Account.

Note:

Please note the code is valid for 24 hours.
If you did not receive the code, select Resend, then enter the new code.

Follow the instructions given on the screen and set up the Authenticator App:
- Install an authenticator app on your device. It is recommended to register your email in the app before proceeding.
- Scan the QR code displayed on the screen. After scanning, your account will appear in the app.
- Open the added account in the app, note the verification code, and enter it on the MFA screen.
- Select Sign In.
- You are now logged in to the portal.

Forgot Password :

On the Sign in page, select Forgot your password?
On the Reset Password screen, enter your registered email address.
Select Reset my password.
Open the email with the subject Reset your password from developer-support@availity.com and copy the code.
On the Change Password screen:
- Enter the reset code provided in the email.
- Enter your new password.
- Confirm your new password.
- Select Change password.
Once your password is successfully updated, you'll be redirected to the Portal Login page.
Sign in using your updated password and your MFA (Multi-Factor Authentication) code.

Note:

If you are already logged in, log out of your account, clear your browser cookies, and refresh the page to return to the sign-in screen.

Add a new organization

If you are not already logged into the Availity Enterprise Development Portal:
- At the top right of the landing page, select Portal Login to sign in to the portal.
Select your username at the top right of the portal.
Select My Dashboard .
In the menu on the left of your dashboard, select My Org/Users .
If you have not already created an organization:
- Select Create an Organization.
- Enter an Organization Name.
- Select Create Organization.

Note:

Support ticket is required to add user to the new or any existing organization created and select the case reason as " API" in the support ticket. Ensure the following information is included:

User ID and email of the user to be added.
Organization to which the user has to be added.
Organization Admin, Tax ID information (if available).

Register an application

If you are not already logged into the Availity Enterprise Development Portal :
- At the top right of the landing page, select Portal Login to sign in to the portal.
Select My Apps in the menu bar.
Select Create a New App.
Enter application details, and then select Create App.

Subscribe to an API product

If you are not already logged into the Availity Enterprise Development Portal:
- At the top right of the landing page, select Portal Login to sign in to the portal.
Select API Products in the menu bar.
Select More Info to learn more about the accessible APIs in an available API product.
Note: Select the title of any accessible API available in the selected API product to view its full definition.
Select Access this Product to view available subscription plans for the selected API product.
Note:
- The Demo plan is a sandbox environment used to test communication with Availity APIs. It is recommended that you start with a Demo subscription to gain knowledge of the Availity REST API workflow. Demo subscriptions are automatically approved.
- After exploring the Demo Plan, if you’re ready to move forward, first place your subscription request for the Standard Plan on the Developer Portal. Then, email partnermanagement@availity.com. Our Trading Partner Management team will help you complete contracting and activate your subscription. The Standard Plan gives you full access to REST APIs and production data, so you can start using the APIs.
- Team will reach out to you for contract.
- The subscription request will be approved upon verification of contract status.
Select Access with this Plan for the desired subscription plan to add the API product subscription to your cart.
Note: A subscription notification displays below the Access this Product button on the API product overview page.
Select Go to cart in the subscription notification to complete your API product access request.
Note: Selecting the cart icon next to your username at the top right of the portal will also open your cart.
Confirm that API Product to which you want access is listed in the selected product area.
Confirm that the Selected Plan is correct.
In the Select an App area, either select Create a New App and enter application details to create a new application or select Existing App and then select an existing application.
Select Submit Request.

A notification indicates that the subscription request has been submitted for approval. Availity Client Services will now approve the subscription and begin the API key provisioning process.

Demo Subscription

Availity offers a trial package that allows you to begin exploring our APIs without completing a formal application process. Using demo data (without personal health information [PHI]), you'll get up to speed quickly, at no cost to you.

Generating Token for Demo plan: You can choose which demo response you want by sending a header with X-Api-Mock-Scenario-ID and X-Api-Mock-Response: true in your request. The value is the ID of the response scenario you want. For demo response confirmation, inspect the response header for X-Api-Mock-Response: true. You can find supported response scenarios in each applicable API's reference section.

Note:

The Demo environment returns canned responses; therefore, the data you receive does not change based on the request.
Not all Availity APIs support demo response scenarios.

Token Generation

Use this process for all plans except the Demo subscription:

Use the token endpoint from the API's specification for your environment.
Example (Test): https://tst.api.availity.com/v1/token
Fetch the following information from API Portal < MY Apps < MY Apps < Approved Access < Look for the product < Client info< Expand the Client info and enter the information in the respective fields in API Testing tool.
- grant_type : client_credentials
- client_id : {API_Key from approved app}
- client_secret : {Secret from Approved app}
- Scope : For new subscriptions, enter the two scopes separated by single space provided in the product details.
  For existing subscriptions, enter the existing scope which you were using.
Call the OAuth 2 Authentication API using the details provided above.
The API returns an authentication token valid for 5 minutes.
Use this bearer token in the Authorization header for subsequent API calls.

Support Ticket

For any assistance, log in to Availity Essentials and submit an online support ticket anytime (24/7). Navigate to Help & Training → Availity Support within Availity Essentials.

When creating your ticket, set the Case Reason to "API". You can use this option for:

Linking your user account to an organization
Resolving credential issues
Addressing account concerns

Note:

For new subscription requests:

After submitting your subscription request on the Developer Portal, email partnermanagement@availity.com. Our Trading Partner Management team will guide you through contracting and activating the Standard Plan, which provides full access to REST APIs and production data.