JOjoincandidhealth
v4

Get payer

Changed on
get/api/payers/v4/{payer_uuid}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/payers/v4/{payer_uuid}
  • Auth
    HTTP bearer

Path parameters

payer_uuidstring uuid required

Response

Response with status 200

payer_uuidstring uuid required
payer_namestring required

The primary display name of the payer.

payer_category'BCBS' | 'AETNA_AFFILIATED' | 'CIGNA_AFFILIATED' | 'UNITED_AFFILIATED' | 'MEDICARE' | 'NON_TRADITIONAL_MEDICARE' | 'MEDICAID' | 'HOSPICE' | 'SNF' | 'TRICARE' | 'WORKERS_COMP' | 'OTHER_GOVERNMENT' | 'AUTO_TPL' | 'LIEN' | 'HUMANA' | 'MOLINA' | 'OTHER_FACILITY'
alternate_payer_namesstring[] required

The alternate display names of the payer.

clearinghouse_payer_infoobject required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      for the path request parameter payer_uuid, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get removed and replaced with v4_get_3