JOjoincandidhealth
v1

Post

Changed on

Sends real-time eligibility checks to payers through Stedi.

post/eligibility-checks/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/eligibility-checks/v1
  • Auth
    HTTP bearer

Request body

submitter_transaction_identifierstring

A unique identifier for the eligibility check within the batch. Candid returns this identifier in the response for the /batch/{batch_id} polling endpoint so you can correlate benefit responses with the original eligibility check.

payer_idstring required

Supported payer ID values can be found here.

get_existing_check_initiated_afterstring date-time

If not provided, this endpoint will run a fresh eligibility check. If provided, it will return an existing successful eligibility check if one exists that was initiated after provided date with the same parameters (Date of Service, Payer ID, Provider, Subscriber, Dependent, and Encounter).

sourcestring
portal_passwordstring

The password that the provider uses to log in to the payer's portal. This is not commonly used.

portal_usernamestring

The username that the provider uses to log in to the payer's portal. This is not commonly used.

Response

Response with status 200

batch_idstring
responseunknown required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 3a81ee81d4edRevision changes
    • info

      api operation id post removed and replaced with v1_post