- Documentation
- API Reference
- Platform Guide
- Quickstart Guide
- Changelog
- POSTRun Benefit Verification
- GETRetrieve Benefit Verification
- POSTSend Prior Authorization
- GETRetrieve Prior Authorization
- POSTCheck Clinical Qualification
- GETRetrieve Clinical Qualification
- POSTCheck Prior Authorization Status
- POSTSubmit Patient Enrollment
- Authentication
- Webhooks
API Documentation
Retrieve Benefit Verification
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Retrieve details of a specific benefit verification request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
success Represents the data the data contained in the response for a get benefit verification request.
The ID of the benefit verification request.
The type of object the response is about, which is 'benefit_verification'.
benefit_verification Benefit Verifications will always start in the pending state. Once the verification is complete, the status will change to completed or failed. If the verification is still in progress, the status will remain pending.
pending, failed, completed Provides additional information about the verification status.
Specific error information if the benefit verification failed
A brief title summarizing the error.
A specific code identifying the error. This list will likely expand over time to provide more specific error codes. The following codes are currently supported:
- Document Info Missing or Incorrect: The insurance documents provided are missing information that is necessary to identify the patient. The information could be outdated or not present in the documentation. For example, the documents might be missing the member ID for the patient, or could have a medical only ID, or could have an out of date address. To fix this error you can try re-uploading documents that contain the information specified in the message for this error.
- Document Quality Error: The insurance documents provided are not valid insurance documents or are low quality (blurry or low resolution) and therefore cannot be processed by our system. To fix this error you can try re-uploading higher quality documents.
- Insurance Card OCR Failure: This error means we were unable to read the necessary information from the insurance card image provided. This could be due to the image being unclear. Please check the images provided and/or provide the information manually if possible. This is generally an issue that would be handled on your side, and may involve reaching out to the patient to get a better image of their insurance card.
- Insurance Unable to Provide Information: The insurance company was unable to provide the information needed to determine the patient's coverage status. This could be due to various reasons such as the insurance representative being unable or unwilling to provide the necessary details, or issues during the call, like refusal to transfer to a supervisor.
- Patient Not Found: The plan contact we called was unable to locate the patient in their system. We weren't able to identify a root cause issue with the documentation provided, but re-uploading additional documents may help.
- Unable to Gather Benefits: We were unable to gather benefits from the insurance company. This could be due to a variety of reasons, such as the insurance company not being able to provide the information, or the information provided not being sufficient to determine the patient's coverage status. To fix this error, you can try providing insurace information manually and/or providing medication history.
- Internal Error: There was an internal error during the benefit verification.
Patient Not Found, Insurance Card OCR Failure, Insurance Unable to Provide Information, Document Quality Error, Document Info Missing or Incorrect, Unable to Gather Benefits, Internal Error A detailed message explaining the error, such as: 'We were unable to extract the member ID from the insurance card image provided, the image(s) my be unclear.' These messages may be unique to the specific benefit verification request.
The status on if this benefits investigation has been reviewed in the portal. Users of the portal can click the 'Mark as Reviewed' button to mark the benefits investigation as reviewed.
reviewed, not_reviewed List of drug coverage information related to the verification.
The name of the drug.
The prescribed dosage of the drug.
The quantity of the drug prescribed.
This field will start off as null and will be populated if the benefit verification is successfully completed. The drug coverage result
covered, not_covered This field will start off as null and will be populated if the benefit verification is successfully completed. The options are:
- insurer_reported_value: This is the exact value that the insurer reported for the drug coverage.
- diagnoses_not_covered: The drug is being reported as not covered due to this patients specific diagnosis codes
insurer_reported_value, diagnoses_not_covered This field will start off as null and will be populated if the benefit verification is successfully completed. A not_applicable value will be returned if the drug is not covered by the insurance plan.
yes, no, not_applicable This field will start off as null and will be populated if the benefit verification is successfully completed and a copay is received.
A structured representation of the copay options for the drug.
The amount of the copay in cents.
The duration of the supply in days. Use null if unknown.
The patient's drug history
The drugs that the patient is currently taking.
The name of the drug.
The drugs that the patient has previously taken.
The name of the drug.
List of diagnoses for the patient.
ICD-10 code for the diagnosis. i.e. 'E66.9'
Demographic information for the patient
Your internal ID for this patient. This is used for linking all of the requests for a given patient.
The first name of the patient.
The last name of the patient.
The gender of the patient.
male, female, other, not_specified The date of birth of the patient.
The address of the patient.
Street address of residence.
Additional street address information.
City of residence.
State or province of residence.
ZIP or postal code part of the address.
Country of residence.
The contact phone number of the patient.
The contact email address of the patient.
Details of the healthcare provider whose NPI number can be used for the benefit verification.
The first name of the provider.
The last name of the provider.
The address of the provider.
Street address of residence.
Additional street address information.
City of residence.
State or province of residence.
ZIP or postal code part of the address.
Country of residence.
The contact phone number of the provider.
The National Provider Identifier (NPI) of the provider.
List of insurance payers that the provider is in-network with. This is optional and no longer seems to have much of an impact on the verification process. You can omit this if it is not readily available information
A large proportion (20%+) of payers will often ask for information on the legal entity that the provider is associated with. Without this information the benefit verification will fail. Although this is currently optional it will be required in the future. We highly recommend providing this information.
The legal name of the entity. This is the name that the provider is associated with.
The tax identifier of the entity. This is the tax ID that the provider is associated with.
Insurance information for the patient.
Insurance card scanned content.
The client/employer name.
The group number on the card.
The member name on the card.
The member number on the card.
The payer name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card. i.e. 'United Healthcare', 'United', 'United Health' could all appear
The plan name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card
The Rx BIN number on the card.
The Rx group number on the card.
The Rx PCN number on the card.
Error message if we were unable to extract information from the card.
The Base64 encoded insurance card image you send in the request is stored on our servers. A signed URL to the image is returned here. This URL has a short expiry time, so you should download the image immediately after receiving it if you want to view the asset.
This field indicates the insurance coverage status of the patient. The options are:
- covered: Indicates that the patient is covered by the insurance plan.
- patient_not_found: Indicates that the patient could not be found in the insurance database.
- coverage_expired: Implies that the patient's insurance coverage has expired.
- coverage_not_started: Suggests that the patient's insurance coverage is in place but has not started yet.
- patient_not_covered_unspecified: Used when the patient is not covered by the insurance plan, but the specific reason is not specified.
- unknown: We were unable to determine the patient's insurance coverage status.
patient_not_found, coverage_expired, coverage_not_started, covered, patient_not_covered_unspecified, human_unable_to_answer, missing_from_transcript, unknown List of verification methods used to determine the coverage status of the drug. These will contain evidence from the verification procedure, such as a transcript of the phone conversation between the AI and the insurance provider.
The ID of the verification method.
The type of the verification method.
The call transcript
The URL to the call recording
Details of the mock result if one was used for this benefit verification.
An enumeration.
completed The case to simulate for the benefit verification. The options are:
- drugs_covered__prior_auth_required__has_copay: Drug is covered, prior authorization required, and there is a copay.
- drugs_covered__prior_auth_required__no_copay: Drug is covered, prior authorization required, but there is no copay.
- drugs_covered__prior_auth_not_required__has_copay: Drug is covered, no prior authorization required, and there is a copay.
- drugs_covered__prior_auth_not_required__no_copay: Drug is covered, no prior authorization required, and there is no copay.
- drugs_not_covered__prior_auth_na__no_copay: Drug is not covered, prior authorization not applicable (because the drug is not covered), and there is no copay.
drugs_covered__prior_auth_required__has_copay, drugs_covered__prior_auth_required__no_copay, drugs_covered__prior_auth_not_required__has_copay, drugs_covered__prior_auth_not_required__no_copay, drugs_not_covered__prior_auth_na__no_copay