Getting Started

Create an account


  1. Open the Availity for Developers portal at

  2. On the top right of the page, select Create account.

  3. On the Create new account page, complete the fields

  4. Enter a password and complete the CAPTCHA challenge, and then select the Sign up button.

Register an application


  1. While logged in, select the Apps tab on the Availity for Developers homepage.

  2. On the Apps page, select Create new App.

  3. On the Register application page, enter a title and description that includes your organization's name. Select Save.

  4. In the notification dialog that states the application was created successfully, select the eye icon to display the client secret and the eye icon to display the client key. Both are needed to create the OAuth token when provisioning an API Key.

    Warning: Be sure to capture your client secret when it is displayed, as it will no longer be visible after you complete registration.

Subscribe to an API product


  1. While logged in, select the API Products tab on the Availity for Developers homepage.

  2. On the API Products page, select the Healthcare HIPAA Transactions (1.0.0) link (or whichever product you choose).

  3. To subscribe to an API product, you have two plan options: Demo and Standard.

    • The Demo plan is a sandbox environment used to test communication with the APIs. Start with a Demo subscription to gain knowledge of the Availity REST API workflow. Demo subscriptions are automatically approved.

    • When you're comfortable with the workflow and have completed the contracting process with your Trading Partner Manager, you can subscribe to the Standard plan. The subscription request will be approved upon verification of contract status.

    To subscribe to the Standard plan, select Select under the Standard column.

  4. In the Subscribe dialog, select Select.

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

Add a new user


  1. While logged in, select your organization name in the top right corner of the Availity for Developers homepage.

  2. Select My organization from the drop-down list.

  3. On the My organization page, select Invite.

  4. Enter the new user’s email address and select whether the new user is primarily a Viewer, App Developer, or Administrator.

  5. Select Save. The new user will receive an email with instructions for completing registration.