Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Availity

Scalekit connector
Open markdown

The Availity connector lets your AI agent act in each user's Availity account. Each user signs in to Availity once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 11 tools.

Tools
11
What they doRead · write · destructive
8 · 2 · 18 read2 write1 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Availity connection

    In AgentKit > Connections, create an Availity connection. The name you give it is the connection_name your code passes. See Configure connections.

    Console steps with screenshots

    Availity connections use OAuth 2.0 client credentials: the API key and secret of an app on the Availity Developer Portal. The credentials belong to your provider organization, so tool calls act for the organization rather than an individual clinician. Scalekit exchanges the credentials for a short-lived access token and refreshes it.

    1. Create an app on the Availity Developer Portal

      On the Availity Developer Portal, create an app and subscribe it to the HIPAA Transactions API product, on the Demo or Standard plan. Under My Apps > your app > Approved Access > Client info, copy the API Key and the Secret. The secret is shown only once; reset it under My Apps if you lose it.

      Note the scopes the portal lists in your API product’s details.

    2. Create the connection

      In the Scalekit dashboard, go to AgentKit > Connections > Create Connection, find Availity and click Create. Select the scopes your API product lists, such as hipaa, and click Save. The connection name is the connection_name your code passes.

    3. Add a connected account

      To test, open the connection, click the Connected Accounts tab > Add Account, enter the user’s identifier, such as user_123, and fill in:

      • API Key (Client ID): the app’s API key. It’s case sensitive.
      • Secret (Client Secret): the app’s secret.

      In production, the authorization link collects the same two fields.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • availity_claim_status_getGet the full claim status response (X12 277) for one claim status ID.Read-only

    Get Claim Status

    Get the full claim status response (X12 277) for one claim status ID. Returns status and statusCode, payer, submitter, providers, subscriber, patient and claimStatuses with claim control numbers, statusDetails (category, status code, claim and payment amounts, finalized and remittance dates, check number) and serviceLines. Use claim_status_get after claim_statuses_search returns an id. Use claim_statuses_search to start a new inquiry.

    Inputs

    claim_status_idstringrequired
    The claim status ID returned by claim_statuses_search (the id field of a claimStatuses item). Example: 5334032768852043884
  • availity_configurations_listGet a payer's field requirements and validation rules for a transaction type, or list the payers that support that transaction.Read-only

    List Payer Configurations

    Get a payer's field requirements and validation rules for a transaction type, or list the payers that support that transaction. Returns configurations with type, payerId, payerName, and elements describing each field's label, required flag, allowed values, pattern and max length, plus requiredFieldCombinations. Use configurations_list before coverage_create, claim_statuses_search or service_review_create to learn which fields a payer requires. Use payers_list to find payer IDs.

    Inputs

    typestringrequired
    The transaction type to get configuration for. 270 = eligibility and benefits (coverages), service-reviews = creating an authorization or referral, service-reviews-inquiry = searching authorizations, claim-statuses-inquiry = claim status, professional-claims / institutional-claims = patient cost estimates, enhanced-claim-status = Enhanced Claim Status add-on.one of 270service-reviewsservice-reviews-inquiryclaim-statuses-inquiryprofessional-claimsinstitutional-claimsenhanced-claim-status
    limitinteger
    Maximum number of configurations to return, from 1 to 50. Default 50.
    offsetinteger
    Zero-based index of the first configuration to return, for paging. Default 0.
    payer_idstring
    Availity payer ID whose rules you want. Leave empty to list every payer that supports the transaction type. Example: BCBSF
    subtype_idstring
    Subtype for the transaction type. For service-reviews and service-reviews-inquiry: HS (outpatient authorization), AR (inpatient authorization / admission review) or SC (referral). For professional-claims and institutional-claims: PRE_DETERMINATION. For enhanced-claim-status: HIPAA_276, VALUE_ADDS_277, SUMMARY or DETAIL. Leave empty for 270 and claim-statuses-inquiry.
  • availity_coverage_createSend an eligibility and benefits inquiry (X12 270) for a patient to their health plan through Availity.Read-only

    Check Eligibility and Benefits

    Send an eligibility and benefits inquiry (X12 270) for a patient to their health plan through Availity. Returns the coverage with its id, status and statusCode (0 In Progress, 4 Complete, other codes are errors), and once complete the payer, subscriber, patient and plans with benefits. Use coverage_create to start a check. When statusCode is 0, poll coverage_get with the returned id every few seconds until it changes. Use configurations_list with type 270 to see which fields the payer requires.

    Inputs

    payer_idstringrequired
    Availity-specific identifier of the patient's health plan, from payers_list. Example: BCBSF
    service_typestringrequired
    X12 270 service type code for the benefits to check. 30 = Health Benefit Plan Coverage (general eligibility). Other common codes: 1 (Medical Care), 33 (Chiropractic), 35 (Dental Care), 47 (Hospital), 48 (Hospital Inpatient), 50 (Hospital Outpatient), 86 (Emergency Services), 88 (Pharmacy), 98 (Professional Physician Visit - Office), MH (Mental Health), UC (Urgent Care). One code per request.
    as_of_datestring
    Date of service to check coverage for, as YYYY-MM-DD. Defaults to today at the health plan. Example: 2026-01-15
    card_issue_datestring
    Issue date on the member's health plan card, as YYYY-MM-DD, for plans that require it. Example: 2025-01-01
    group_numberstring
    The patient's health plan group number. Example: GRP12345
    medicaid_idstring
    The patient's Medicaid ID number, for Medicaid plans. Example: 123456789012
    member_idstring
    The patient's or subscriber's health plan member ID as printed on the card. Example: ABC123456789
    mock_scenario_idstring
    Demo plan only. ID of the canned response scenario Availity's Demo plan should return, sent as the X-Api-Mock-Scenario-ID header. Leave empty on the Standard (production) plan. Valid IDs for this operation: Coverages-Complete-i, Coverages-InProgress-i, Coverages-Retrying-i, Coverages-PayerError1-i, Coverages-PayerError2-i, Coverages-RequestError1-i, Coverages-RequestError2-i.
    patient_birth_datestring
    The patient's date of birth as YYYY-MM-DD. Most health plans require it. Example: 1980-01-01
    patient_first_namestring
    The patient's first name. Example: SAMPLE
    patient_genderstring
    The patient's gender code: M (male), F (female) or U (unknown).one of MFU
    patient_last_namestring
    The patient's last name. Example: TESTPATIENT
    patient_middle_namestring
    The patient's middle name or initial. Example: Q
    patient_statestring
    Two-letter code of the patient's state of residence, for plans that require it. Example: FL
    patient_suffixstring
    The patient's name suffix. Example: JR
    payer_assigned_provider_idstring
    An identifier the health plan assigned to the requesting provider, for plans that accept one. Example: P12345
    place_of_servicestring
    Place of service code, for health plans that require it (X12 code source 237). Example: 11 (office)
    procedure_codestring
    Procedure code to check benefits for, such as a CPT or HCPCS code, for plans that support procedure-level inquiries. Example: 99213
    provider_citystring
    The requesting provider's city, for health plans that require it. Example: JACKSONVILLE
    provider_first_namestring
    The requesting provider's first name, when the provider is a person. Example: ALEX
    provider_last_namestring
    The requesting provider's last name or organization name. Example: EXAMPLE CLINIC
    provider_npistring
    The requesting provider's 10-digit National Provider Identifier. Most health plans require it. Example: 1234567893
    provider_specialtystring
    The requesting provider's specialty as an X12 provider taxonomy code (code source 682). Example: 207Q00000X
    provider_statestring
    The requesting provider's two-letter state code, for health plans that require it. Example: FL
    provider_tax_idstring
    The requesting provider's 9-digit tax ID with no dashes, for health plans that require it. Example: 123456789
    provider_zip_codestring
    The requesting provider's ZIP code, for health plans that require it. Example: 32202
    submitter_idstring
    A payer-assigned submitter identifier, for health plans that require it. Example: G12345
    subscriber_relationshipstring
    The patient's relationship to the subscriber when the patient is not the subscriber: 18 (self), 01 (spouse), 19 (child) or G8 (other relationship).one of 180119G8
    to_datestring
    End date of the coverage period to check, as YYYY-MM-DD, for health plans that support a date range. Example: 2026-01-31
  • availity_coverage_getGet an eligibility and benefits (X12 271) result by its coverage ID.Read-only

    Get Eligibility and Benefits

    Get an eligibility and benefits (X12 271) result by its coverage ID. Returns the coverage with status and statusCode, payer, requestingProvider, subscriber, patient, plans (coverage status, group number, dates and benefits) and any validationMessages from the payer. Use coverage_get to poll a check started with coverage_create until statusCode is no longer 0 (In Progress). Results expire at expirationDate.

    Inputs

    coverage_idstringrequired
    The coverage response ID returned by coverage_create (the id field). Example: 7276849100383928590
    mock_scenario_idstring
    Demo plan only. ID of the canned response scenario Availity's Demo plan should return, sent as the X-Api-Mock-Scenario-ID header. Leave empty on the Standard (production) plan. Valid IDs for this operation: Coverages-Complete-i, Coverages-InProgress-i, Coverages-Retrying-i, Coverages-PayerError1-i, Coverages-PayerError2-i.
  • availity_payers_listList the health plans (payers) available through Availity on your contract, optionally filtered by payer ID, supported transaction type or submission mode.Read-only

    List Payers

    List the health plans (payers) available through Availity on your contract, optionally filtered by payer ID, supported transaction type or submission mode. Returns each payer's name, payerId, displayName, shortName and processingRoutes (transaction, submission mode, enrollment requirement, effective date). Use payers_list to find the payerId that coverage_create, claim_statuses_search and service_review_create need. Use configurations_list for a payer's field-level validation rules.

    Inputs

    availabilitystring
    Filter by contract requirement: available returns payers that do not need an additional Availity contract, contractrequired returns payers that do.one of availablecontractrequired
    enrollment_requiredboolean
    Filter by whether enrollment with Availity is required to submit the transaction. true returns only payers that need enrollment; false only those that do not.
    payer_idstring
    Availity-specific payer identifier to look up a single payer. Leave empty to list every payer on your contract. Example: BCBSF
    submission_modesarray
    Only return payers that accept the transactions through these submission methods: Portal, Batch, RealTime or API. Example: ["API"]
    transaction_typesarray
    Only return payers that support these EDI transaction types. Common values: 270 (eligibility and benefits), 276 (claim status), 278I (service review / prior authorization inquiry), 835 (remittance), 837P and 837I (professional and institutional claims). Example: ["270", "276"]
  • availity_service_review_getGet one prior authorization or referral (service review) by its ID, including the payer's decision.Read-only

    Get Service Review

    Get one prior authorization or referral (service review) by its ID, including the payer's decision. Returns status and statusCode (for example A1 Certified in Total, A4 Pended), certificationNumber, referenceNumber, certification dates, updatable and deletable flags, updatableFields, payerNotes, validationMessages, diagnoses, procedures and providers. Use service_review_get to poll a review submitted with service_review_create or to read one found with service_reviews_search.

    Inputs

    service_review_idstringrequired
    The service review ID returned by service_review_create or service_reviews_search (the id field). Example: 12345678
    mock_scenario_idstring
    Demo plan only. ID of the canned response scenario Availity's Demo plan should return, sent as the X-Api-Mock-Scenario-ID header. Leave empty on the Standard (production) plan. Valid IDs for this operation: SR-GetComplete-i, SR-GetInProgress-i, SR-GetRetrying-i, SR-GetPayerDown-i (with ID 12345678).