Skip to main content

Submit compliance check job​

Submits a batch job to evaluate compliance of therapy notes and documents. The job can include signed file URLs, custom evaluation criteria, or a predefined group of criteria.

Once the job is submitted, you can consume the result in one of two ways:

  • Polling: Call GET /compliance/job/{jobId} to check the status and retrieve results when complete.
  • Webhook: Receive a COMPLIANCE_JOB_COMPLETED or COMPLIANCE_JOB_FAILED event to your registered webhook URL.

See Using webhooks for more details about webhook delivery, payload format, and security.

Request Body required
  • files object[] required

    The files to check for compliance.

  • Array [
  • id string required

    The ID of the file.

  • url string required

    The URL of the file. The URL has to be obtained from the GET /compliance/upload-url endpoint. Only PDF files are supported.

  • ]
  • criteria string[]

    Possible values: [provider_name_and_credentials, client_name_and_dob, care_delivery_method, service_modality, client_location, provider_signature_and_date, date_of_service, session_start_and_stop_times, attendees, diagnostic_statement_present, presenting_problem, goals_addressed_in_session, measurable_goals, interventions_utilized, client_response_to_interventions, risk_assessment, mental_status_examination, plan, intensive_level_of_care, current_symptoms_and_behaviors, progress_towards_goals, specific_services_rendered]

    List of criteria identifiers to evaluate. Descriptions of each criterion can be found here

  • criteriaGroups string[]

    Possible values: [therapy_notes]

    Predefined groups of compliance criteria

Responses

Compliance job was submitted successfully.

Schema
  • jobId string required

    The ID of the submitted compliance job.

Loading...