> ## Documentation Index > Fetch the complete documentation index at: https://trust.denialbase.com/llms.txt > Use this file to discover all available pages before exploring further. # Execute next action > Triggers execution of the next pending action in the plan. ## OpenAPI ````yaml /api-reference/openapi.yaml post /api/v1/action_plans/{id}/execute_next openapi: 3.1.1 info: title: Denialbase API version: 1.0.0 description: >- The Denialbase API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. ## Base URL ``` /api/v1 ``` ## Authentication Denialbase uses **httpOnly cookie-based JWT** authentication. Authenticate by sending a `POST /api/v1/auth/session` request with your credentials. The server sets a secure session cookie that is automatically included in subsequent requests. All API requests must be made over HTTPS in production. Requests without valid authentication return a `401 Unauthorized` error. Two-factor authentication (TOTP), passkeys (WebAuthn), magic links, and Google OAuth are also supported. ## Errors Denialbase uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error with the information provided. Codes in the `5xx` range indicate a server error. | Code | Description | |------|-------------| | 200 | OK — Request succeeded | | 201 | Created — Resource successfully created | | 400 | Bad Request — Invalid parameters | | 401 | Unauthorized — Invalid or missing authentication | | 403 | Forbidden — Insufficient permissions | | 404 | Not Found — Resource does not exist | | 422 | Unprocessable Entity — Validation failed | | 429 | Too Many Requests — Rate limit exceeded | | 500 | Internal Server Error — Something went wrong on our end | ## Pagination List endpoints return paginated results. Use `page` and `per_page` query parameters to control pagination. Responses include pagination metadata in the response body. ## Rate Limiting API requests are rate limited per IP address and per authenticated user. When rate limited, you will receive a `429 Too Many Requests` response. Back off and retry after a brief delay. servers: - url: /api/v1 security: [] tags: - name: WellKnown x-displayName: JWKS & Discovery description: JSON Web Key Set (JWKS) and OpenID Connect discovery endpoints. - name: Api::V1::ActionPlan x-displayName: Action Plans description: AI-generated appeal action plans with approval and execution workflows. - name: Api::V1::Action x-displayName: Actions description: Individual appeal actions (calls, faxes, letters) within action plans. - name: Api::V1::Confirmation x-displayName: Email Confirmation description: >- Action confirmation workflow — review, confirm, modify, or cancel pending actions. - name: Api::V1::Admin::AuditLog x-displayName: Audit Logs description: HIPAA-aligned audit logs with resource history and user activity tracking. - name: Api::V1::Admin::BetaSignup x-displayName: Beta Signups description: Admin management of beta signup requests (approve or reject). - name: Api::V1::Admin::Denial x-displayName: Denial Management description: Admin denial management — insurer and provider assignment. - name: Api::V1::Admin::EobReview x-displayName: EobReview - name: Api::V1::Admin::Feedback x-displayName: User Feedback (Admin) description: Admin feedback management — view, respond to, and update feedback status. - name: Api::V1::Admin::FormTemplate x-displayName: Form Templates (Admin) description: Admin form template management with DocuSeal field mapping. - name: Api::V1::Admin::HealthcareCode x-displayName: Healthcare Codes description: Admin healthcare code management (CPT, CARC/RARC) with external sync. - name: Api::V1::Admin::InsurerLearningPattern x-displayName: Learning Patterns description: >- Insurer-specific learning patterns discovered by AI, with approval workflow. - name: Api::V1::Admin::Insurer x-displayName: Insurers description: Admin insurer configuration, intelligence, and analytics. - name: Api::V1::Admin::InvestorCredential x-displayName: InvestorCredential - name: Api::V1::Admin::LearningInsight x-displayName: Learning Insights description: AI learning insights — trends, strategies, and operational metrics. - name: Api::V1::Admin::Operational x-displayName: Operational Monitoring description: Admin operational monitoring — escalations, costs, and external events. - name: Api::V1::Admin::Organization x-displayName: Organization - name: Api::V1::Admin::ProviderOnboarding x-displayName: ProviderOnboarding - name: Api::V1::Admin::Provider x-displayName: Providers description: Admin healthcare provider management and request tracking. - name: Api::V1::Admin::SsoConnection x-displayName: SsoConnection - name: Api::V1::Admin::SupportGap x-displayName: Support Gaps description: Identified gaps in platform support coverage for denial types or insurers. - name: Api::V1::Admin::UserStat x-displayName: User Statistics description: Aggregate user statistics and platform usage metrics. - name: Api::V1::Admin::User x-displayName: User Management description: >- Admin user management — view details, block, unblock, and set spending limits. - name: Api::V1::Admin::UserJourney x-displayName: User Journeys description: Admin view of user journey timelines and activity history. - name: Api::V1::OmniauthCallback x-displayName: OAuth Callbacks description: OAuth callback handlers for third-party login providers. - name: Api::V1::Auth::Session x-displayName: Sessions description: User login and session management via httpOnly cookie-based JWT. - name: Api::V1::Auth::Sso x-displayName: Sso - name: Api::V1::AuthorizationForm x-displayName: Authorization Forms description: HIPAA authorization forms with DocuSeal e-signature integration. - name: Api::V1::AuthorizationGrant x-displayName: AuthorizationGrant - name: Api::V1::AuthorizationGrants::GrantedScope x-displayName: GrantedScope - name: Api::V1::AuthorizationGrants::Revoke x-displayName: Revoke - name: Api::V1::BetaSignup x-displayName: Beta Signup description: Beta signup requests for early access to the platform. - name: Api::V1::Conversation x-displayName: Conversations description: AI-powered conversations for appeal guidance and support. - name: Api::V1::Cost x-displayName: Costs description: Cost tracking and financial summaries for appeal-related actions. - name: Api::V1::DataExport x-displayName: Data Export description: User data exports in various formats for portability. - name: Api::V1::DelegationScope x-displayName: DelegationScope - name: Api::V1::Document x-displayName: Documents description: User-uploaded documents such as EOBs, medical records, and correspondence. - name: Api::V1::Feedback x-displayName: Feedback description: User feedback submissions for features and support requests. - name: Api::V1::FormDelivery x-displayName: Form Deliveries description: Form delivery tracking (fax, email, portal) with confirmation workflows. - name: Api::V1::FormTemplate x-displayName: Form Templates description: Reusable form templates for insurer-specific submissions. - name: Api::V1::Health x-displayName: Health - name: Api::V1::Help x-displayName: Help & Support description: Help articles and contextual assistance for platform pages. - name: Api::V1::InsuranceCard x-displayName: Insurance Cards description: Insurance card image uploads with OCR-based data extraction. - name: Api::V1::InsuranceProfile x-displayName: Insurance Profiles description: Insurance plan profiles with coverage and plan details. - name: Api::V1::InsuranceProfileMember x-displayName: Profile Members description: Members and dependents on insurance profiles. - name: Api::V1::Integration x-displayName: Integrations description: Third-party integrations (EHR, patient portals) via OAuth. - name: Api::V1::InvestorSession x-displayName: InvestorSession - name: Api::V1::Invitation x-displayName: Invitation - name: Api::V1::Lookup x-displayName: Lookup - name: Api::V1::MySponsorship x-displayName: MySponsorship - name: Api::V1::Notification x-displayName: Notifications description: In-app notification inbox with read and dismiss controls. - name: Api::V1::Npi x-displayName: Npi - name: Api::V1::Onboarding x-displayName: Onboarding description: Guided onboarding wizard steps and progress tracking. - name: Api::V1::Org::Appeal x-displayName: Appeal - name: Api::V1::Org::Approval x-displayName: Approval - name: Api::V1::Org::Authorization x-displayName: Authorization - name: Api::V1::Org::Caseload x-displayName: Caseload - name: Api::V1::Org::Client x-displayName: Client - name: Api::V1::Org::PatientInsuranceProfile x-displayName: PatientInsuranceProfile - name: Api::V1::Org::Dashboard x-displayName: Dashboard - name: Api::V1::Org::DenialSubmission x-displayName: DenialSubmission - name: Api::V1::Org::FormRequirement x-displayName: FormRequirement - name: Api::V1::Org::Insurer x-displayName: Insurer - name: Api::V1::Org::Intake x-displayName: Intake - name: Api::V1::Org::Invoice x-displayName: Invoice - name: Api::V1::Org::Logo x-displayName: Logo - name: Api::V1::Org::Notification x-displayName: Notification - name: Api::V1::Org::Onboarding x-displayName: Onboarding - name: Api::V1::Org::PartnerApiKey x-displayName: PartnerApiKey - name: Api::V1::Org::Provider x-displayName: Provider - name: Api::V1::Org::PublicInfo x-displayName: PublicInfo - name: Api::V1::Org::Report x-displayName: Report - name: Api::V1::Org::Session x-displayName: Session - name: Api::V1::Org::Setting x-displayName: Setting - name: Api::V1::Org::SsoConnection x-displayName: SsoConnection - name: Api::V1::Org::SupportedInsurer x-displayName: SupportedInsurer - name: Api::V1::OrgIntake x-displayName: OrgIntake - name: Api::V1::Organization x-displayName: Organization - name: Api::V1::Organizations::ClientSponsorship x-displayName: ClientSponsorship - name: Api::V1::Organizations::Invitation x-displayName: Invitation - name: Api::V1::Organizations::Membership x-displayName: Membership - name: Api::V1::OverturnableDenial x-displayName: Denials description: Insurance claim denials eligible for appeal, with AI-powered analysis. - name: Api::V1::CallbackPromise x-displayName: Callback Promises description: Scheduled callback promises from insurers with follow-up tracking. - name: Api::V1::Deadline x-displayName: Deadlines description: Appeal deadline tracking and urgency management. - name: Api::V1::Evidence x-displayName: Evidence description: Evidence documents and confidence tracking for denial appeals. - name: Api::V1::ExternalEvent x-displayName: External Events description: >- External events related to denials, such as insurer responses and status changes. - name: Api::V1::Partner::EmbedToken x-displayName: EmbedToken - name: Api::V1::Passkey x-displayName: Passkeys (WebAuthn) description: Passkey (WebAuthn) registration and authentication for passwordless login. - name: Api::V1::ProductFeedback x-displayName: ProductFeedback - name: Api::V1::ReasonCode x-displayName: Reason Codes description: CARC and RARC reason code lookup and search. - name: Api::V1::Scan x-displayName: Document Scans description: Document scanning and OCR-based data extraction from uploaded images. - name: Api::V1::Search x-displayName: Search description: Global search across denials, documents, and actions. - name: Api::V1::SecurityPreference x-displayName: Security Preferences description: >- Security and privacy settings including data sharing consent and verification. - name: Api::V1::ServiceCode x-displayName: Service Codes description: CPT and HCPCS service code lookup and search. - name: Api::V1::TaskCredential x-displayName: TaskCredential - name: Api::V1::TwoFactor x-displayName: Two-Factor Auth description: >- TOTP-based two-factor authentication setup, verification, and backup codes. - name: Api::V1::Unsubscribe x-displayName: Unsubscribe description: Email notification unsubscribe management via token-based links. - name: Api::V1::User x-displayName: User Profile description: Current user profile, password management, and account deletion. - name: Api::V1::Webhooks::BlandAi x-displayName: Bland AI (Calls) description: Bland AI webhook callbacks for automated phone call results. - name: Api::V1::DeckWebhook x-displayName: DeckWebhook - name: Api::V1::Webhooks::Docuseal x-displayName: DocuSeal (Signatures) description: DocuSeal webhook callbacks for e-signature completion events. - name: Api::V1::Webhooks::InboundEmail x-displayName: Inbound Email description: Inbound email webhook callbacks for insurer correspondence. - name: Api::V1::Webhooks::Lob x-displayName: Lob - name: Api::V1::Webhooks::Phaxio x-displayName: Phaxio (Fax) description: Phaxio webhook callbacks for fax delivery status updates. - name: Api::V1::Webhooks::Telnyx x-displayName: Telnyx (SMS) description: Telnyx webhook callbacks for SMS delivery status updates. - name: Api::V1::WebsocketTicket x-displayName: WebSocket Tickets description: WebSocket authentication tickets for real-time update channels. - name: Api::V1::Whitelabel::Embed x-displayName: Embed - name: Api::V1::Whitelabel::Form x-displayName: Form - name: Api::V1::Whitelabel::Guest x-displayName: Guest - name: Api::V1::Whitelabel::Intake x-displayName: Intake - name: Api::V1::Whitelabel::ProviderIntake x-displayName: ProviderIntake paths: /api/v1/action_plans/{id}/execute_next: post: tags: - Api::V1::ActionPlan summary: Execute next action description: Triggers execution of the next pending action in the plan. parameters: - name: id in: path required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: {} responses: '200': description: OK content: application/json: schema: type: object properties: result: type: object properties: status: type: string enum: - draft - pending_approval - approved - in_progress - completed - failed - cancelled action_id: type: string result: type: object properties: status: type: string enum: - draft - pending_approval - approved - in_progress - completed - failed - cancelled required: - status required: - action_id - result - status plan: type: object properties: id: type: string action_context: type: object properties: action_types: type: array items: type: string has_insurance_card: type: boolean patient: type: object properties: name: type: - string - 'null' name_source: type: - string - 'null' member_id: type: - string - 'null' member_id_source: type: - string - 'null' date_of_birth: type: - string - 'null' group_number: type: - string - 'null' required: - date_of_birth - group_number - member_id - member_id_source - name - name_source claim: type: object properties: claim_id: type: - string - 'null' service_dates: type: array items: type: string provider_name: type: - string - 'null' provider_npi: type: - string - 'null' required: - claim_id - provider_name - provider_npi - service_dates services: type: array items: type: object properties: procedure_code: type: string procedure_description: type: string service_code: type: - string - 'null' service_description: type: - string - 'null' reason_code: type: - string - 'null' reason_description: type: - string - 'null' diagnosis_codes: type: array items: type: string denied_amount: type: number format: float service_date: type: - string - 'null' required: - denied_amount - diagnosis_codes - procedure_code - procedure_description - reason_code - reason_description - service_code - service_date - service_description insurer: type: object properties: name: type: - string - 'null' matched: type: boolean verified: type: boolean phone: type: - string - 'null' fax: type: - string - 'null' address: type: - string - 'null' required: - address - fax - matched - name - phone - verified authorization: type: object properties: status: type: string enum: - not_started - not_signed - signed - pending_delivery - delivered - confirmed signed: type: boolean required: - signed - status delegation_authorization: type: object properties: status: type: string enum: - draft - pending_approval - approved - in_progress - completed - failed - cancelled signed: type: boolean required: - signed - status history: type: array items: type: object deadline: type: - object - 'null' data_quality: type: object properties: blockers: type: array items: type: object properties: field: type: string message: type: string action: type: string input_type: type: - string - 'null' placeholder: type: - string - 'null' required: - action - field - message warnings: type: array items: type: object properties: field: type: string message: type: string required: - field - message missing_fields: type: array items: type: string user_actions_needed: type: array items: type: object properties: field: type: string action_type: type: string prompt: type: string required: type: boolean input_type: type: - string - 'null' placeholder: type: - string - 'null' required: - action_type - field - prompt - required completeness_percent: type: integer required: - blockers - completeness_percent - missing_fields - user_actions_needed - warnings required: - action_types - authorization - claim - data_quality - deadline - delegation_authorization - has_insurance_card - history - insurer - patient - services actions: type: array items: type: object properties: id: type: string action_communications: type: array items: type: object action_type: type: string enum: - call - fax - email - file_appeal - request_info - sign_form - wait - request_external_review - confirm_form_on_file - renew_authorization - deliver_form approved_at: type: string call_context: type: object properties: greeting: type: string objective_summary: type: string objectives: type: array items: type: object properties: text: type: string priority: type: integer required: - priority - text decision_branches: type: array items: type: object properties: scenario: type: string action: type: string capture: type: array items: type: string required: - action - capture - scenario extraction_schema: type: object properties: reference_number: type: object properties: type: type: string description: type: string required: - description - type rep_name: type: object properties: type: type: string description: type: string required: - description - type rep_extension: type: object properties: type: type: string description: type: string required: - description - type call_outcome: type: object properties: type: type: string enum: type: array items: type: string description: type: string required: - description - enum - type next_steps_described: type: object properties: type: type: string description: type: string required: - description - type callback_promised: type: object properties: type: type: string description: type: string required: - description - type callback_within_days: type: object properties: type: type: string description: type: string required: - description - type resolution_status: type: object properties: type: type: string enum: type: array items: type: string description: type: string required: - description - enum - type appeal_address: type: object properties: type: type: string description: type: string required: - description - type documentation_requirements: type: object properties: type: type: string description: type: string required: - description - type appeal_deadline_confirmed: type: object properties: type: type: string description: type: string required: - description - type claim_summary: type: object properties: claim_id: type: - string - 'null' denial_count: type: integer total_denied_amount: type: string denials: type: array items: type: object properties: id: type: string procedure_code: type: string description: type: string denied_amount: type: string service_date: type: - string - 'null' denial_code: type: string reason: type: - string - 'null' reason_code_description: type: - string - 'null' required: - denial_code - denied_amount - description - id - procedure_code - reason - reason_code_description - service_date required: - claim_id - denial_count - denials - total_denied_amount reference_data: type: object properties: patient_name: type: - string - 'null' member_id: type: string date_of_birth: type: - string - 'null' claim_id: type: - string - 'null' denials: type: array items: type: object properties: id: type: string procedure_code: type: string description: type: string denied_amount: type: string service_date: type: - string - 'null' denial_code: type: string reason: type: - string - 'null' reason_code_description: type: - string - 'null' required: - denial_code - denied_amount - description - id - procedure_code - reason - reason_code_description - service_date total_denied_amount: type: string prior_reference_numbers: type: array items: type: string prior_rep_names: type: array items: type: string promise_details: type: array items: type: object authorization_status: type: string ivr_steps: type: - boolean - 'null' insurer_tips: type: - boolean - 'null' overturn_reasoning: type: string required: - authorization_status - claim_id - date_of_birth - denials - insurer_tips - ivr_steps - member_id - overturn_reasoning - patient_name - prior_reference_numbers - prior_rep_names - promise_details - total_denied_amount prior_interactions: type: array items: type: object data_completeness: type: object properties: completeness_percent: type: integer missing_fields: type: array items: type: object properties: field: type: string tier: type: string required: - field - tier field_availability: type: object properties: patient_name: type: boolean member_id: type: boolean claim_id: type: boolean phone_number: type: boolean date_of_birth: type: boolean authorization_status: type: boolean denial_code: type: boolean service_date: type: boolean denied_amount: type: boolean ivr_steps: type: boolean insurer_tips: type: boolean prior_reference_numbers: type: boolean policy_number: type: boolean required: - authorization_status - claim_id - date_of_birth - denial_code - denied_amount - insurer_tips - ivr_steps - member_id - patient_name - phone_number - policy_number - prior_reference_numbers - service_date required: - completeness_percent - field_availability - missing_fields state_signals: type: object properties: is_first_contact: type: boolean has_pending_promises: type: boolean escalation_warranted: type: boolean forms_pending_confirmation: type: boolean denial_count: type: integer prior_call_count: type: integer required: - denial_count - escalation_warranted - forms_pending_confirmation - has_pending_promises - is_first_contact - prior_call_count overturn_arguments: type: object properties: reasoning: type: string confidence_score: type: number format: float denial_type: type: - string - 'null' recommended_strategy: type: string required: - confidence_score - denial_type - reasoning - recommended_strategy call_config: type: object properties: voice: type: string model: type: string language: type: string wait_for_greeting: type: boolean record: type: boolean required: - language - model - record - voice - wait_for_greeting max_duration: type: integer voice: type: string phone_number: type: - string - 'null' insurer_name: type: - string - 'null' department: type: string deadline_urgency: type: - object - 'null' required: - call_config - claim_summary - data_completeness - deadline_urgency - decision_branches - department - extraction_schema - greeting - insurer_name - max_duration - objective_summary - objectives - overturn_arguments - phone_number - prior_interactions - reference_data - state_signals - voice completed_at: type: - string - 'null' created_at: type: string error_message: type: - string - 'null' executed_at: type: - string - 'null' metadata: type: object properties: purpose: type: string objectives: type: array items: type: string llm_call_context: type: object properties: greeting: type: string objectives: type: array items: type: object properties: text: type: string priority: type: integer required: - priority - text decision_branches: type: array items: type: object properties: scenario: type: string action: type: string capture: type: array items: type: string required: - action - capture - scenario objective_summary: type: string required: - decision_branches - greeting - objective_summary - objectives required: - llm_call_context - objectives - purpose prerequisite_action_ids: type: array items: type: string prerequisites_check: type: object properties: satisfied: type: boolean missing_forms: type: array items: type: string missing_deliveries: type: array items: type: string missing_confirmations: type: array items: type: string missing_actions: type: array items: type: string required: - missing_actions - missing_confirmations - missing_deliveries - missing_forms - satisfied result: type: object properties: {} retry_count: type: integer scheduled_for: type: - string - 'null' sequence_order: type: integer status: type: string enum: - pending_prereqs - ready - pending_approval - pending_confirmation - approved - executing - completed - failed - cancelled supported: type: boolean target_denial_ids: type: array items: type: string target_denials: type: array items: type: object properties: id: type: string procedure_code: type: string procedure_description: type: string required: - id - procedure_code - procedure_description target_entity_matched: type: boolean target_name: type: string target_party: type: string enum: - insurer - provider - patient - pharmacy - other unsupported_reasons: type: array items: type: string updated_at: type: string required: - action_communications - action_type - approved_at - call_context - completed_at - created_at - error_message - executed_at - id - metadata - prerequisite_action_ids - prerequisites_check - result - retry_count - scheduled_for - sequence_order - status - supported - target_denial_ids - target_denials - target_entity_matched - target_name - target_party - unsupported_reasons - updated_at ai_reasoning: type: string approved_at: type: - string - 'null' claim_id: type: - string - 'null' completed_at: type: - string - 'null' created_at: type: string denial_count: type: integer insurer_matched: type: boolean insurer_name: type: - string - 'null' narrative: type: - object - 'null' overturnable_denial_id: type: string overturnable_denial_ids: type: array items: type: string overturnable_denials: type: array items: type: object properties: id: type: string action_plan_generating: type: boolean assessment_count: type: integer claim_denial_count: type: integer claim_id: type: - string - 'null' claim_insurer_name: type: - string - 'null' claim_patient_name: type: - string - 'null' claim_provider_name: type: - string - 'null' claim_total_denied: type: number format: float denial_code: type: string denial_reason: type: - string - 'null' denied_amount: type: number format: float detected_at: type: string formatted_reference_code: type: string needs_reassessment: type: boolean organization_name: type: - string - 'null' policy_document_id: type: - string - 'null' procedure_code: type: string procedure_description: type: string reason_code_description: type: - string - 'null' reference_code: type: string reviewed_at: type: - string - 'null' service_date: type: - string - 'null' source_document_id: type: string status: type: string enum: - new - reviewed - dismissed summary_title: type: - string - 'null' required: - action_plan_generating - assessment_count - claim_denial_count - claim_id - claim_insurer_name - claim_patient_name - claim_provider_name - claim_total_denied - denial_code - denial_reason - denied_amount - detected_at - formatted_reference_code - id - needs_reassessment - organization_name - policy_document_id - procedure_code - procedure_description - reason_code_description - reference_code - reviewed_at - service_date - source_document_id - status - summary_title status: type: string enum: - draft - pending_approval - approved - in_progress - completed - failed - cancelled total_denied_amount: type: number format: float updated_at: type: string version: type: integer required: - action_context - actions - ai_reasoning - approved_at - claim_id - completed_at - created_at - denial_count - id - insurer_matched - insurer_name - narrative - overturnable_denial_id - overturnable_denial_ids - overturnable_denials - status - total_denied_amount - updated_at - version required: - plan - result ````