> ## 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. # Get insurer intelligence > Returns AI-generated intelligence and analytics for an insurer. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/v1/admin/insurers/{id}/intelligence 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/admin/insurers/{id}/intelligence: get: tags: - Api::V1::Admin::Insurer summary: Get insurer intelligence description: Returns AI-generated intelligence and analytics for an insurer. parameters: - name: id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string active: type: boolean appeal_levels: type: integer appeal_ready: type: boolean appeals_address: type: string appeals_email: type: string appeals_fax: type: string appeals_phone: type: string business_hours: type: object properties: {} call_timing_patterns: type: array items: type: object properties: day_of_week: type: integer day_name: type: string hour_of_day: type: integer department: type: string enum: - claims - appeals - billing - prior_auth - member_services - other call_count: type: integer success_rate: type: number format: float avg_hold_time_minutes: type: string required: - avg_hold_time_minutes - call_count - day_name - day_of_week - department - hour_of_day - success_rate common_problems: type: array items: type: string completeness_score: type: object properties: score: type: integer breakdown: type: object properties: contact: type: object properties: filled: type: integer total: type: integer required: - filled - total web: type: object properties: filled: type: integer total: type: integer required: - filled - total operations: type: object properties: filled: type: integer total: type: integer required: - filled - total intelligence: type: object properties: filled: type: integer total: type: integer required: - filled - total required: - contact - intelligence - operations - web required: - breakdown - score contact_effectiveness: type: array items: type: object properties: insurer_type: type: string enum: - commercial - medicare - medicaid - tricare - other contact_method: type: string enum: - phone - fax - email - portal department: type: string enum: - claims - appeals - billing - prior_auth - member_services - other success_rate: type: number format: float connection_rate: type: number format: float avg_hold_time: type: string avg_call_duration: type: string total_attempts: type: integer tips: type: array items: type: string required: - avg_call_duration - avg_hold_time - connection_rate - contact_method - department - insurer_type - success_rate - tips - total_attempts created_at: type: string departments: type: object properties: {} display_name: type: string email: type: string fax: type: string insurer_type: type: string enum: - commercial - medicare - medicaid - tricare - other is_regional_variant: type: boolean ivr_navigation: type: object properties: {} learning_pattern_count: type: integer member_portal_url: type: - string - 'null' metadata: type: object properties: {} name: type: string organization_id: type: - string - 'null' parent_insurer: type: - object - 'null' parent_name: type: - string - 'null' pending_learning_patterns: type: array items: type: object properties: id: type: string pattern_type: type: string source: type: string confidence_score: type: string occurrences: type: integer pattern_data: type: object properties: tip: type: string required: - tip created_at: type: string required: - confidence_score - created_at - id - occurrences - pattern_data - pattern_type - source phone: type: string preferred_channel: type: - string - 'null' enum: - phone - fax - portal - email region: type: - string - 'null' regional_variant_count: type: integer regional_variants: type: array items: type: object properties: id: type: string active: type: boolean appeal_ready: type: boolean created_at: type: string display_name: type: string insurer_type: type: string enum: - commercial - medicare - medicaid - tricare - other is_regional_variant: type: boolean name: type: string preferred_channel: type: - string - 'null' enum: - phone - fax - portal - email region: type: string short_code: type: string updated_at: type: string verified: type: boolean required: - active - appeal_ready - created_at - display_name - id - insurer_type - is_regional_variant - name - preferred_channel - region - short_code - updated_at - verified required_form_types: type: array items: type: string required_form_types_custom: type: boolean short_code: type: string tips: type: array items: type: string typical_response_days: type: object properties: {} updated_at: type: string verified: type: boolean verified_at: type: - string - 'null' verified_by: type: - object - 'null' website: type: string required: - active - appeal_levels - appeal_ready - appeals_address - appeals_email - appeals_fax - appeals_phone - business_hours - call_timing_patterns - common_problems - completeness_score - contact_effectiveness - created_at - departments - display_name - email - fax - id - insurer_type - is_regional_variant - ivr_navigation - learning_pattern_count - member_portal_url - metadata - name - organization_id - parent_insurer - parent_name - pending_learning_patterns - phone - preferred_channel - region - regional_variant_count - regional_variants - required_form_types - required_form_types_custom - short_code - tips - typical_response_days - updated_at - verified - verified_at - verified_by - website ````