An API Product is a collection of related APIs offered as a single unit for subscription. Products simplify access by grouping APIs that support a common business workflow.

A Plan defines the access level and usage limits for an API Product.

There are generally two types of subscriptions - A demo plan and standard plan.

• Demo plan: is the preferred starting point. Subscribing to the Demo plan will allow access to our sandbox environment, which provides canned responses for each of the API endpoints. Subscriptions to the Demo plan are automatically approved, so you can start testing right away. The purpose of the Demo plan is for users to test and establish connectivity with our API endpoints, understand the flow of API calls, and generally get acquainted with our system. You will not be able to do end-to-end testing on the Demo plan, or test with any live data. The Documentation sections covers the scenarios provided in the Demo plan.
• Standard Plan: 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.
• Default: Available for certain products without demo subscription.

Each plan specifies rate limits (e.g., transactions per second) and daily quotas.

An organization represents your company or group within the Developer Portal. It links your applications, subscriptions, and users under a single entity for better management and compliance.

Best Practice: You must be linked to an organization before creating an application. This ensures your apps and API subscriptions are correctly associated with your organization for approvals and support.

Yes. Organization Admins should use the Create Organization option under: My Apps → My Org/Users → Create New Organization.

For other associates from your organization, please follow the steps outlined in the Get Started page under the section "Add a new organization" to join an existing organization or refer FAQ.

No, you cannot delete an organization directly from the portal. If you need to disassociate or remove an organization, please contact the Support Team by raising a ticket (Case Reason: API).

You can be associated with only one organization at a time. If you need to change your organization, Please contact the Support Team by raising a ticket (Case Reason: API).

An Application (App) is the link between your organization, and our authentication system and API Subscription plans. You must create an application before subscribing to any API Product, this is how the portal links your approved plans to the credentials you'll use for testing and production.

Note: Ensure you are linked to your organization before creating an application. This ensures your apps and API subscriptions are correctly associated with your organization for approvals and support.

Application editing is currently not allowed.

Deleting an application will remove all associated approved subscriptions and API keys. Be cautious, this action cannot be undone.

If you have registered using the same email ID previously associated with Availity, please ask your Organization Admin to add you to the Organization. If you are unsure who your Organization Admin is, submit a support ticket with Case Reason: API, including your User ID, Email, and Organization Name.

If you still cannot view your organization or applications after these steps, raise a support ticket for further assistance.

Note: Only organization administrators can view associated apps. If you were not previously the owner of your organization, you will not see any apps or subscription after re-registration. In this case, your organization must have a registered org admin.

If your org admin is no longer with your organization, please notify Availity by submitting a support ticket. Include the following details:

• Organization name
• Previous org admin's email address
• New org admin's email address

This will allow us to complete the association on your behalf.

In order to use Availity's APIs, You must subscribe to an API Product from a Catalogue by choosing a Plan that is associated to it, under API Products page.

There are generally two types of subscriptions - A demo plan and standard plan.

The Demo plan is the preferred starting point. Subscribing to the Demo plan will allow access to our sandbox environment, which provides canned responses for each of the API endpoints. Subscriptions to the Demo plan are automatically approved, so you can start testing right away. The purpose of the Demo plan is for users to test and establish connectivity with our API endpoints, understand the flow of API calls, and generally get acquainted with our system. You will not be able to do end-to-end testing on the Demo plan, or test with any live data. Refer to the Availity API Guide to learn more about the Demo Plan, including available testing options and scenarios.

The Standard Plan: 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.

Both subscriptions are subject to rate limits:

The Demo plan is limited to 5 transactions per second, and 500 per day.

The Standard plan is limited to 100 transactions per second, and 100,000 per day and it may vary by product (example: Eligibility and Benefits Value adds).

Once the application is created, each approved subscription creates a unique key-secret pair tied to the selected plan. If you subscribe to multiple plans for the same product, you'll receive separate keys. Please note, each Product requires new access request, when approved carries new API Key-Secret pair.

Refer Subscribe to an API product under Get Started.

You'll receive email notification on Approval or Rejection of your request. Additionally, You can also check status in the portal under My Apps → Select App Name→ App Details→ Approved/Pending based on the status.

If you see this error, you have two options:

• Complete the existing subscription request for the product already in your cart.
• Delete the product from your cart to add a different product.

Yes, Select the Demo Plan for quick testing. Demo plans are auto-approved, you will get credentials instantaneously. The credentials will appear under My Apps → Select App Name→ App Details and can be used in Insomnia or any preferred API testing tool. For detailed steps, see the Availity API Guide.

Note: Only selected API Products offer a Demo Plan for testing.

When your subscription request is approved, you receive an API Key and Secret. To generate a token refer Get Started page or Availity API Guide.

For Demo plan your subscription request will be auto approved, you receive an API Key and Secret instantly, refer to detailed instruction on Get Started page, Demo section or Availity API Guide.

This functionality is currently deprecated.

Each type of subscription has two different transaction limits: a maximum allowed per second, and a maximum allowed per day. Demo plan subscriptions are limited to a maximum of 5 transactions per second, and 500 transactions per day. The Standard plan is limited to 100 transactions per second, and 100,000 per day and it may vary by product (example: Eligibility and Benefits Value adds).

Please note that every REST API call is counted in your transaction limits. This includes the OAuth token call, and each initial request and subsequent polling requests.

If you start receiving a '429' response code, you have exceeded one of the transaction limits. If it's the per second limit, you will be able to successfully send transactions the next second. If it's the per day limit, the counter will reset at midnight EST, and you will be able to successfully send transactions immediately the next day.

Availity does not have the capability to override these limits manually on an as needed basis. If you are consistently exceeding your transactions limits on a standard plan, please contact your Availity Trading Partner Manager or email partnermanagement@availity.com about to resolve.

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.

Simply email partnermanagement@availity.com. Our Trading Partner Management team will assist you with contracting and subscribing to the Standard Plan, which provides full access to REST APIs and production data.

To add a user to any organization, you must raise a support ticket, Navigate to Help & Training → Availity Support within Availity Essentials. Further select the case reason as "API." Include the following details in the ticket:

• User ID and Email of the user to be added
• Organization Name to which the user should be added
• Organization Admin and Tax ID information (if available)

The functionality exists currently, but you should not delete the user as it disassociates the user from org.

To create an account, follow the steps outlined in the Create Account section on the Get Started page.

Use the Forgot Password option on the login page and follow the instructions provided in the Get Started page<Create Account< Password Reset.

To log in to the Developer Portal, go to the API Developer Portal home page and click the Login button at the top-right corner. A login window will appear, enter your credentials to access your account.

Account deletion is currently not allowed.

Log in to the portal using your existing email ID.

• If you are an Organization Admin, you will automatically be linked to your organization as team member.
• If you are an associate, you will initially be linked to a default organization. Please contact your Organization Admin to who will need to open a Support ticket with Case reason API to associate you with the correct organization.
• Once the admin completes the association, you will see your applications in approved state.

Note: Your existing subscription keys will continue to work.

Yes, your current subscription keys will remain active and continue to work without any changes.

After completing your registration and getting linked to your organization, you will see your application in an approved state. It will display a new set of API Key and Secret. This does not affect your existing subscriptions, your current keys will continue to work as usual.

Some migrated apps were temporarily assigned to a placeholder owner (a system user with a placeholder email). This preserved subscriptions and metadata until real users re-registered and reclaiming could be completed.

See the Configurations API documentation in the Availity API Guide.

Refer to the HIPAA Guide in the Documentation section for detailed steps.

SOAP APIs are not directly available on the Developer Portal. However, their API Specifications Document can be accessed under the respective API Product pages.

Note: The credentials used for REST APIs will not work for SOAP APIs. SOAP APIs require separate credentials and a different integration method.

Some users have reported receiving the following error message when requesting Enhanced Claim Status information from the payer Florida Blue:

A sender number is needed for this function. Please obtain a check or EFT number from a Florida Blue payment within the past 90 days and contact Availity Client Services at 1-800-282-4548 for assistance.

You can request a Florida Blue Sender Number/SenderID through Availity. Call Availity Client Services (ACS) at 1-800-282-4548 and supply the following information:

• Organization type
• Organization name
• Organization physical address
• Tax ID (Ensure that this ID is associated with the Florida Blue Provider ID)
• Best contact phone number
• Name of the Availity user requesting the Sender ID
• Email
• Availity Customer ID
• Florida Blue Provider ID
• Florida Blue check number
• Check amount
• Check date
• Pay-to address

Payer approval typically occurs within 24-48 hours. Once approved, the SenderID will appear in View Identifiers/Organization Identifiers on the Availity Essentials portal for you to capture and use in transactions.

If the payer supports the MEMBER_ID option, follow these steps for best practice:

1. Run an Enhanced Claim Status Summary call. This a proprietary call that does not use the 276/277 transaction, but returns high-level claim information as well as multiple claims.
2. Next, run an Enhanced Claim Status Detail call with the claim number returned in the MEMBER_ID summary response from Step 1. This a proprietary call that does not use the 276/277 transaction, but returns detailed claim information for a single claim. See the Enhanced Claim Status reference documentation for more information.