Socotra

Getting Started

  • Introduction to Socotra
    • Overview
      • What is Socotra?
      • What is Socotra Insurance Suite?
    • What is the Getting Started with Socotra learning path?
    • Have questions?
    • Ready for the next module?
  • Log into Socotra
    • Overview
      • What will I learn?
      • What will I need?
    • Key concepts
      • What is a business account?
      • Ready to begin?
    • Steps
    • Recap
    • Ready for the next module?
  • Create a tenant configuration file
    • Overview
      • What will I learn?
      • What will I need?
      • Note about JSON
    • Key concepts
      • What is a tenant configuration file?
      • What is a tenant?
      • How is a tenant configuration file structured?
      • What is an insurance product?
      • What is an account holder?
      • What is an element?
      • Visualizing an insurance product configuration
      • Ready to begin?
    • Part 1 - Creating a configuration file
    • Part 2 - Basic editing of the tenant configuration file
      • View the configuration file
      • Concept - Attributes
      • Concept - Default attributes
      • Edit the default attributes
      • Concept - Attribute types
    • Part 3 - Advanced editing of the tenant configuration file
      • View the Products menu
      • Making changes to the product
    • Recap
    • Ready for the next module?
  • Overview - Tenants
    • What is a tenant?
    • Tenants page
    • Tenant configuration page
      • Users
      • Resources
        • Resource instances
        • Resource groups
    • Ready for the next module?
  • Create a tenant
    • Steps
    • Ready for the next module?
  • Set up Postman to use the Socotra API
    • Overview
      • What will I learn?
      • What will I need?
        • Issues with your credentials?
      • Ready to begin?
    • Steps
      • Part 1 - Set up your collection and environment
      • Part 2 - Set up your environment
      • Part 3 - Authenticate with Socotra
    • Make a request to test your authentication
    • Troubleshooting
    • Recap
    • Ready for the next module?
  • Create an account
    • Key concepts
      • What is an account?
      • What is the process for creating an account?
    • API steps
      • What will I need?
      • Create an account
      • Update an account
      • Validate an account
    • Web app steps
    • Recap
    • Ready for the next module?
  • Execute a quote to bind
    • Overview
      • What will I learn?
      • What will I need?
    • Key concepts
      • What is a quote?
      • What is a policy?
      • Life cycle of a quote
      • Resetting a quote
      • Atypical quote states
      • Ready to begin?
    • Steps
      • Part 1 - Create a quote
        • Request body breakdown
      • Part 2 - Validate the quote
      • Part 3 - Price the quote
      • Part 4 - Underwrite the quote
      • Part 5 - Accept the quote
      • Part 6 - Issue the quote
    • Recap
    • Ready for the next module?
  • Execute policy transactions
    • Overview
      • What will I learn in this tutorial?
      • What will I need?
    • Key concepts
      • What is a policy?
      • What are terms and segments?
        • Terms
        • Segments
      • What is a policy transaction?
    • Example scenarios
      • Example 1 - Changing a policy
      • Example 2 - Renewing a policy
      • Example 3 - Canceling a policy
    • Tutorials
      • Scenario - Homeowner seeking to modify home insurance coverage
      • Tutorial 1 - Making a change to a policy
        • 1.1 - Locating customer’s account number in Postman
        • 1.2 - Locating customer’s policy in Postman
        • 1.3 - Retrieving customer’s policy details
        • 1.4 - Creating a change transaction
        • 1.5 - Issuing a change transaction
        • 1.6 - Viewing the changed policy
      • Tutorial 2 - Renewing a policy
      • Tutorial 3 - Canceling a policy
      • Tutorial 4 - Reinstating a policy
    • Ready for the next module?
  • Trigger billing, pay, and invoices
    • Overview
      • What will I learn?
      • What will I need?
    • What is the billing life cycle?
    • Walkthrough the billing life cycle
    • Stage 1: Quote is issued (via API)
    • Stage 2: System generates an installment lattice
    • Stage 3: System generates installments
    • Stage 4: System generates invoice(s)
    • Stage 5: Payment is created (via API)
    • Stage 6: Payment is posted to invoice (via API)
  • Socotra sample Postman collection and environment
  • Set up and use the Config SDK for tenant configuration
    • Overview
      • What is the Config SDK?
      • Advantages to using the Config SDK
        • Advantage example: Streamlining data typing
        • Advantage example: Generating Java classes
      • What will I learn?
      • What will I need?
    • Steps
      • Part 1 - Create a Personal Access Token
      • Part 2 - Download and configure the Config SDK
      • Part 3 - Fetch your tenant’s config
      • Part 4 - Update and validate the configuration
      • Part 5 - Write a plugin
      • Part 6 - Write tests
  • Create a user
    • Key concepts
      • Users
      • Admins
      • Ready to begin?

Feature Guide

  • Business Accounts
    • Overview
    • See also
  • Accounts
    • Overview
    • Configuring accounts
      • Example: BaseAccount
      • Example: CommercialAccount
      • Example: ConsumerAccount
    • Account states
    • Limiting products to certain account types
    • Extension data
    • See also
  • Contact Management
    • Overview
    • Configuring Contacts
    • Contact States
    • Tutorial
    • Merging Contacts
    • Searchability
  • Quotation Topic Index
    • Quotes
      • Quote State Flow
        • Standard Flow
        • Atypical States
      • Quote Reset
      • Time Zones
      • Currencies
      • Error Handling
      • See Also
    • Quick Quotes
      • Overview
      • Workflow
      • Quotation
      • Discard
      • See Also
  • Policy Management Topic Index
    • Policy Transactions
      • Structure
      • Provisional Transactions
      • Basic Transactions
      • Process
      • Transaction Reset
      • See Also
    • Policy Transaction Stack
      • Workflow
      • Transaction Data
      • Documents
      • Validation
      • See Also
    • Policy Elements
      • Overview
      • Categories and Types
        • Example
      • Quantifiers
      • Coverage Terms
      • Data Extensions
      • See Also
    • Policy Status
      • Overview
      • Obtaining Policy Status
        • API
        • Event Stream
    • Coverage Terms
      • Overview
      • Configuration
        • Sample Configuration
      • Elements with Coverage Terms
        • Creation
        • Update
        • Default Coverage Term Options and Values
        • Plugins
    • Out of Sequence Transactions
      • Overview
      • High-Level Approach
      • Static Locators
      • Intervening Out-of-Sequence Transactions
      • Reversals
      • See Also
    • Transaction Branching and Invalidation
      • Example
      • Details
      • Elements
      • Auto-Rebasing
      • See Also
    • Reinstatement
      • Overview
      • Behavior
      • Reinstatement After Multiple Cancellations
      • Reinstatement with a Gap
    • Renewal Management and Auto-Renewal
      • Overview
      • Manual Renewal
      • Auto-Renewal
        • Auto-Renewal States
        • Auto-Renewal Plugin
        • Manual Renewal Operations on an Auto-Renewal
      • Cancellations and Auto-Renew
      • Do Not Renew
      • Renewal with a Gap
      • See Also
    • Policy Holds
      • Overview
      • Lifecycle
      • Policy & Quote Holds
      • Auto-Renewal Holds
      • See Also
  • Schedules
    • Overview
    • Use Cases
    • Key Capabilities
    • Configuration
      • Data Structure
    • Charges and Pricing
      • Plugin Interfaces
    • API Usage
      • Quotes
      • Transactions
    • Data & Reporting
      • API
      • Data Lake
    • See Also
  • Billing Topic Index
    • Installment Lattices
      • Overview
      • Structure
      • Process
      • See Also
    • Installment Settings
      • Overview
      • Settings List
      • Resolving Settings
        • Quotes Process
        • Quotes Example
        • Policy Transactions Process
      • Account Preferences
      • Validation
      • Persistence
      • Default Settings
      • See Also
    • Invoicing
      • Overview
      • Structure
      • Due Times
      • Invoice Rendering
      • Invoice Fees
        • Example
      • See Also
    • Early Invoicing
      • Overview
      • Invocation
      • Behavior
      • Error Conditions
      • See Also
    • Flat Charges
      • Overview
      • Configuration
      • Usage
        • Flat Charges via Rating
        • Flat Charges via API
        • Invoicing Behavior
        • Delinquency
    • Payments
      • Overview
      • Payment State Flow
      • Financial Instruments
      • External Cash Transactions
      • Payment Distribution
      • Payment Reversals
      • Aggregate Payments
        • Example
      • See Also
    • Autopay
      • Overview
      • Installments and Invoices
      • Autopay Plugin
      • Payment Requests
      • See Also
    • Payment Execution Service
      • Overview
      • Setup
      • Initial Process
      • Retry Plans
      • Retry Process
      • Post-Execution Plugin
        • Process
        • Execution Log
      • See Also
    • Delinquency
      • Overview
      • Configuration
      • Delinquency Onset
      • Lapse
      • See Also
    • Delinquency Events
      • Overview
      • Configuration
      • Operation
      • See Also
    • Billing Holds
      • Overview
      • Lifecycle
      • Invoice Holds
      • Delinquency Holds
      • See Also
    • Disbursements
      • Overview
      • Lifecycle
      • Credit Sources
      • Financial Instruments
      • Configuration and Data Extensions
      • Accounting
      • See Also
    • Credit Balances
      • Overview
      • Usage
      • See Also
    • Excess Credits
      • Overview
      • Configuration
      • Process
        • Automatic Disbursement Handling
      • See Also
    • Auto Credit Application
      • Overview
      • Key Concepts
      • How It Works
        • Configuration
        • Processing Logic
        • Triggers
      • Best Practices
      • Limitations
    • Credits from Policy Transactions and Billing Changes
      • Overview
      • Example 1: Standard Cancellation
      • Example 2: Lapse
      • See Also
    • Payment Shortfall Handling
      • Overview
      • Configuration and Plans
      • Plan Selection
      • Application
      • Payment Reversal
      • See Also
    • Backloading Installments
      • Overview
      • Initial State
      • Lattice Creation
      • Charge Processing
      • Invoicing
      • Results
    • Write-Offs
      • Overview
        • Key Capabilities
        • Accounting Behavior
      • API Usage
        • Reversal Support
      • Limitations
      • See Also
  • Financials Topic Index
    • Charges
      • Categories
      • Charge Types
      • Reference Rates
      • Data Precision
    • Durations
      • Overview
      • Usage
      • Configuration
      • Supported Duration Bases
      • Daylight Saving Time
    • Rounding Service
    • Basic Double-Entry Accounting Primer
      • Introduction
      • General Principles
      • T-Accounts
      • Transactions
      • See Also
    • Simplified Accounting Example
      • Overview
      • Summary
      • See Also
  • Underwriting
    • Overview
      • What is an underwriting plugin?
      • What is an underwriting flag?
    • Post-underwriting Evaluation
      • Evaluation algorithm
        • Tips
      • Underwriting status
    • Example Underwriting Scenario
    • See also
  • Documents Topic Index
    • Document Management
      • Overview
      • Document Retrieval
      • Direct Document Attachment and Modification
        • Attaching New Documents
        • Updating Documents
      • See Also
    • Dynamic Documents
      • Template Languages
      • Velocity Example
      • Controlling Template Data
      • Document Snippets
        • Snippets Example (Velocity)
      • Custom Fonts
      • Troubleshooting and Template Development
        • Streamlining the rendering feedback loop
    • Document Consolidation
      • Example
      • Notable Behavior and Limitations
  • First Notice of Loss (“FNOL”)
    • Overview
    • Configuration
    • State Flow and Validation
    • Losses
    • Versioning
    • Promotion
    • See Also
  • Search
    • Overview
    • Example
      • Request
      • Response
    • Requests
      • Search String Syntax
      • Filtering
    • Responses
      • Relevance
      • Search Summary
        • Field Augmentation
      • Sample Responses
    • Configuration
    • See Also
  • Security Topic Index
    • Security Overview
      • Who Should Read This
      • Core Principles
      • Topics Covered
      • Next Steps
    • Authentication and Identity
      • Best Practices
      • Next Steps
      • See Also
    • Role-Based Access Control (RBAC)
      • Roles
      • Permissions
      • Wildcard Formatting
      • Special Roles
      • Tenant Scope
      • Special Tenant Values
      • Next Steps
      • See Also
    • Comprehensive Permissions Listing
      • Next Steps
      • See Also
    • Personal Access Tokens
      • Managing Personal Access Tokens
      • Using Personal Access Tokens in Postman
      • Best Practices
      • Next Steps
      • See Also
    • Audit Logging
      • Use Cases
      • Viewing the Audit Log
      • Next Steps
      • See Also
    • Secure Deployment
      • Automation
      • Authentication
      • Administration
      • Development
      • Next Steps
      • See Also
    • Encryption
      • Best Practices
      • Next Steps
      • See Also
    • Password Policies
      • Configurable Policies
      • Mandatory Policies
      • Best Practices
      • Next Steps
      • See Also
    • Security Standards and Regulations
      • Next Steps
      • See Also
    • PCI Compliance Position Statement
      • Overview
      • Customer Responsibility
        • Compliance Validation
      • Socotra’s Position
        • Service Provision
        • Compliance Assertions
      • Documentation and Support
        • Available Resources
        • Limitations
      • Key Principles
  • Migration
    • Overview
    • Migration Structure
      • Bring Your Own Identifiers
    • Migration Management
      • Remediation
    • Migration Tutorial
      • Prerequisites
      • Get the sample config and source data
      • Make a migration request and check results
      • Handle a failed migration
      • Using a converter
    • Migration Client
      • Obtaining the Client
      • Migration Client Tutorial
        • Prerequisites
        • Configuring the Migration Client
        • Configuring the processor
        • Using patch files
        • Using Coda
  • Reporting Topic Index
    • Metrics
      • Overview
      • API Usage
        • Aggregations
        • Filters
        • Backfill Zero
      • Metric Definitions
        • Gross Written Premium
        • Issued Policies
        • Priced Quotes
        • New Business Conversion Rate
        • Issued Renewals
        • Expired Policies
        • Renewal Rate
    • Data Lake
      • Getting Started with Socotra Data Lake
        • Prerequisites
        • Data Lake Schema
      • Frequently Asked Questions (FAQ)
        • Can I connect with Tableau, Microsoft Power BI, or other such analytical tools?
        • How can I use datetime values in Data Lake?
        • What is a locator?
        • What is a tenant locator?
        • How are rows uniquely identified in Data Lake tables?
        • What is the relationship between the Data Lake schema and entity representations in the Socotra API?
        • What version of MariaDB is Data Lake on?
        • How often is Data Lake data updated?
        • Are there alternative ways to consume Data Lake data?
      • Index of Tables
    • Data Lake Delta Files
      • Getting Started with Data Lake Delta Files
        • Overview
        • Schema Versioning
        • Pagination
        • Client Example
      • File Index API
        • Sample DeltaFilesGetRequest
        • Sample DeltaFilesGetResponse
      • File Retrieval API
      • See Also
  • Previews
    • Overview
      • Stateful Preview
      • Stateless Preview
      • Billing Previews
  • Work Management Topic Index
    • Work Management Overview
    • Diaries
      • Overview
      • Diary Entries
      • Revisioning
      • Discard
      • See Also
    • Tasks
      • Overview
      • Configuration
      • Deadlines
      • Creation of Tasks
    • Underwriting Blocks
    • Task Diaries
    • User Associations
      • Overview
      • Scope
      • Configuration
      • Role Qualification
      • User Association State
      • Association History
    • Media
      • Overview
      • Example

Configuration Guide

  • Configuration General Topics Index
    • Configuration Deployment
      • Overview
      • Configuration Structure
      • Configuration Validation
      • Configuration Case Sensitivity
      • Inheritence Case Sensitivity
      • See Also
    • Configuration Redeployment
      • Overview
      • Safe Changes
      • Migratable Changes
      • Disallowed Changes
      • Future Functionality
        • Locking
        • Retirement
    • Configuration Bootstrap
      • Overview
      • Notes
        • Bootstrap Directory
        • Validations
        • Example
    • Configuration SDK
      • Overview
        • Do I really need an SDK to write and maintain configs?
      • Getting Started
        • Get the source control template
        • Update the config plugin to point at a target tenant
        • Use tasks as you build your config
      • Bootstrapping
    • Quantifiers
      • Overview
      • Structure
        • Element Quantifiers
        • Coverage Term Quantifiers
        • Data Extension Quantifiers
      • Automatic Items
        • Automatic Elements
        • Automatic Coverage Terms
    • Identifiers
      • Overview
      • Items with Identifier Names
      • Rules
    • Availability
      • Overview
      • Configuration
      • Examples
        • Setting a product to retire after a certain time
        • Retiring a product
        • Making an element available to new policies starting after a certain time
        • Automatically removing certain coverage terms on policy renewal
      • Additional Considerations
        • Inheritance
        • Non-Policy Entities
    • Regions
      • Overview
      • Use Cases
        • Configuration
        • Quote and Policy Regions
    • Entity Numbering
      • Overview
      • Process
      • Configuration
      • Prefixes, Suffixes, and Numbering Strings
      • Additional Characters
      • Term Numbers
      • Overriding Automatically Generated Numbers
      • Fetch
      • Error Handling
      • Limitations
      • See Also
    • Events
      • Event Stream Usage
      • Payloads
        • Billing
        • Policy Status
      • Custom Events
        • Configuring Custom Events
        • Emitting Custom Events
      • See Also
    • Custom Scheduled Events
      • Overview
        • Configuration
        • Behavior
      • API
      • Example Use Cases and Configuration
        • Example #1 - (basic) Single event, some time after policy start
        • Example #2 - (moderate) Recurring event upon every anniversary
        • Example #3 - (advanced) Recurring, day of every other month event
    • Event Definitions
      • Account Events
      • Policy Status Events
      • Quote Events
      • Transaction Events
      • Credit Distribution Events
      • Delinquency Event Events
      • Delinquency Events
      • Disbursement Events
      • Installment Events
      • Invoice Events
      • Numbering Events
      • Payment Events
      • Shortfall Credit Events
      • Write Off Events
      • Migration Events
      • Event Payloads
      • See Also
    • Webhooks
      • Managing Webhooks
        • Failure Handling
        • Security Features
      • See Also
    • Data Access Controls
      • Overview
      • Enabling Data Access Controls
      • Configuring Data Fields
      • Assigning User Data Masks
      • See Also
    • Single Sign-On (SSO)
      • Overview
      • Step 1: Register Socotra as a New Application in Your Identity Provider
      • Step 2: Add your Identity Provider to Socotra
        • Sample request
      • Step 3: Receive Service Provider (SP) Metadata from Socotra
        • Sample response
      • Step 4: Configure Your Identity Provider with Socotra’s SP Metadata
      • Step 5: Test the SSO Integration
      • Key SSO Capability Clarifications
  • Resources Topic Index
    • Versioned Resource Selection
      • Overview
      • Key Concepts
      • The Selection Time Basis
      • API and Entity Structure
      • Runtime Behavior in Plugins
      • Document Selection
      • Unmanaged Resources
      • Usage Example
    • Data Tables
      • Overview
      • Configuration
      • Limitations
    • Documents
      • Overview
      • Document Scope
      • Policy Document Workflow
      • Quotation
      • Static and Dynamic Documents
      • Document Consolidation
      • Plugins
        • Policy Document Selection Plugin
        • Document Data Snapshot Plugin
        • Document Consolidation Snapshot Plugin
        • See Also
  • Data Extensions Topic Index
    • Data Extensions
      • Overview
      • Data Scopes
      • Data Types
      • Quantifiers and Arrays
      • Validation Requirements
      • Other Data Properties
      • Comprehensive Properties List
      • See Also
    • Data Extension Types
      • Overview
      • Built-In Data Types
      • Date Types
        • datetime
        • date
      • Custom Data Types
      • Limitations
    • Extension Data Constraints
      • Overview
      • Structure
      • Configuration
      • Dependency Maps
      • Constraint Evaluation API
        • Constraint Evaluation for Accounts
      • Referencing Other Elements
      • Validation
    • Custom Data Types
      • Usage
      • Custom Data Inheritance
    • Validation
    • Static Data
      • Overview
      • Context and Use Cases
      • Configuration
      • Usage - Quotes
        • Setting Static Data
        • Fetching Static Data
      • Usage - Policies
        • Setting Static Data
        • Fetching Static Data
  • Plugins Topic Index
    • Plugins Overview
      • Overview
      • Plugin Execution
      • Plugin Configuration
      • Precommit and Validation
      • Data Fetcher
      • Resource Selector
      • External API Calls
    • Precommit
      • Overview
      • Plugin Execution
      • Manual Execution
      • Account
      • Quote
      • Transaction
      • Payment
      • Disbursement
      • Delinquency
    • Validation
      • Overview
      • Plugin Execution
      • Account
      • Quote
    • Rating
      • Overview
      • Configuration
      • Return Object
    • Underwriting Plugin
      • Overview
        • Underwriting Flag Levels Refresher
        • Underwriting Evaluation Process
        • Common Applications
        • Blocked Underwriting
      • Plugin Configuration
        • Interface Requirements
        • Return Object
        • Checking for Existing Flags
      • Complete Template Example
      • Best Practices Summary
    • Document Data Snapshot
      • Overview
      • Example
    • Document Selection
      • Overview
    • Installments
      • Overview
      • Plugin Execution
      • Adjustment Rules
      • Implementation Example
      • See Also
    • Autopay and Payment Execution
      • Overview
      • See Also

API Guide

  • Business Account API Index
    • Authentication API
      • Endpoint Index
      • Creation
      • Fetch
      • Deletion
    • Tenant Management API
      • Endpoint Index
      • Cloning
    • User Management API
      • Endpoint Index
      • Users
      • Roles
      • Permissions
      • User Role Assignments
      • User Tenant Assignments
  • Accounts API
    • Endpoint Index
    • Fetch
    • Account Creation
    • Updating
    • Validation
    • Contact Management
    • Quotes and Policies
    • Holds
    • Billing
    • Numbering
  • Contacts API
    • Endpoint Index
  • Quotes API Index
    • Quotes API
      • Endpoint Index
        • Main Flow
      • Fetch
      • Quote Creation
      • Update
      • Validation
      • Pricing
      • Underwriting
      • Acceptance
      • Issuance
      • Quote Copy and Group Assignment
      • Static Data
      • Documents
      • Billing
      • Contacts
      • Numbering
      • Holds
        • Atypical States and Operations
    • Quotes Schedules API
      • Endpoint Index
      • Fetch
      • Updating
      • See Also
  • Quick Quotes API
    • Endpoint Index
    • Contacts
    • See Also
  • Policy Management API Index
    • Policies API
      • Endpoint Index
      • Fetch
      • Static Data
      • Snapshots
      • Billing
      • Numbering
      • Contacts
      • Holds
    • Policy Transactions API
      • Endpoint Index
        • Main Flow
      • Fetch
      • Transaction Creation
      • Updating
      • Validation
      • Pricing
      • Underwriting
      • Acceptance
      • Issuance
      • Documents
        • Transaction Details
        • Atypical States and Operations
      • Deprecated Items
    • Policy Transactions Schedules API
      • Endpoint Index
      • Fetch
      • Updating
      • See Also
    • Policy Terms API
      • Endpoint Index
      • Fetch
      • Term Summaries
      • Numbering
    • Renewal Management and Auto-Renewal API
      • Endpoint Index
      • Fetch
      • Create
      • Update
      • Plan Updates
      • See Also
    • Policy Holds API
      • Endpoint Index
      • Fetch
      • Creation and Update
      • Execution
      • Release and Discard
      • Entities
      • Fetch Holds for a Policy or Quote
      • See Also
  • Billing API Index
    • Main Index
      • Installments API
        • Endpoint Index
      • Installment Lattices API
        • Endpoint Index
        • See Also
      • Invoices API
        • Endpoint Index
        • Fetch
        • Update
        • Invoice Documents
        • Invoice Preview
        • Numbering
        • Early Invoicing
      • Payments API
        • Endpoint Index
        • Fetch
        • Create and Update
        • Payment Requests
        • Shortfall Credits
        • Payments by invoice
        • See Also
      • Payment Execution API
        • Endpoint Index
        • Providers
        • Financial Instruments
        • See Also
      • Disbursements API
        • Endpoint Index
        • Fetch
        • Lifecycle
        • Numbering
        • See Also
      • Credit Distribution API
        • Endpoint Index
        • Fetch
        • Creation and Update
        • Execution
        • Reversal
        • Reset and Discard
        • Invoices
      • Credits API
        • Endpoint Index
      • Flat Charges API
        • Endpoint Index
        • Create and Reverse
        • Add Invoice Fee to Policy or Quote
        • Fetch
      • Account Balances API
        • Endpoint Index
      • Financial Instruments and External Cash Transactions API
        • Endpoint Index
        • Financial Instruments
        • External Cash Transactions
      • Delinquency API
        • Endpoint Index
        • Delinquency Plan Assignment
        • Fetch
        • Delinquency Updates
        • Delinquency Events
        • See Also
      • Billing Holds API
        • Endpoint Index
        • Fetch
        • Creation and Update
        • Execution
        • Release, Reset, and Discard
        • See Also
      • Write-Offs API
        • Endpoint Index
        • See Also
    • Policy Service Endpoints
  • First Notice of Loss (“FNOL”) API
    • Endpoint Index
    • Fundamental Operations
    • Data Fetch
    • Numbering
    • Contacts
    • Loss Management
    • Events
    • See Also
  • Work Management API
    • Endpoint Index
    • Tasks
    • User Associations
  • Accounting API
    • Endpoint Index
    • Accounting Transactions
    • Accounting T-Accounts
    • Cash Accounts
  • Documents API
    • Endpoint Index
    • Fetch
    • Modification
    • Ad-hoc Rendering
    • See Also
  • Resources API Index
    • Resource Service API
      • Endpoint Index
      • Resource Groups
      • Resources
    • Document Resources API
      • Endpoint Index
      • Document Resources
      • Document Templates
      • Document Snippets
      • Custom Fonts
    • Tables API
      • Endpoint Index
      • Data Tables
        • Usage
        • Configuration
      • Constraint Tables
        • Accounts
        • Quotes
        • Quick Quotes
        • Policy Transactions
        • Configuration
    • Secrets API
      • Endpoint Index
  • Data API Index
    • Aux Data API
      • Endpoint Index
    • Diary API
      • Endpoint Index
      • Fetch
      • Creation
      • Revisioning
      • Discard
      • See Also
    • Events API
      • Endpoint Index
      • Fetch
      • See Also
    • Diverted Events API
      • Endpoint Index
      • See Also
    • Search API
      • Endpoint Index
      • Data Search
      • See Also
    • Media API
      • Endpoint Index
      • Fetch
      • Management
  • Reporting API Index
    • Metrics API
      • Endpoint Index
      • Metrics Data Reponse Endpoints
      • Metrics CSV Download Endpoints
      • Metrics Request and Response Objects
      • See Also
    • Data Lake Delta Files API
      • Endpoint Index
      • Delta File Endpoints
      • Metrics Request and Response Objects
      • See Also
  • Configuration and Development API Index
    • Configuration Deployments API
      • Endpoint Index
      • Tenant Creation
      • Fetch
      • Redeployment
      • Validation
      • Utility
      • Configuration Entities
    • Developer API
      • Endpoint Index
    • Logging API
      • Endpoint Index
    • Jobs API
      • Endpoint Index
      • Documents Jobs
      • Job Retrigger
      • Installment Jobs
      • Invoice Jobs
        • Normal Invoicing
        • Early Invoicing
      • Delinquency Jobs
    • Identity Providers API
      • Endpoint Index
    • Webhooks API
      • Endpoint Index
      • See Also
    • Passwords API
      • Endpoint Index
      • Fetch
      • Update
      • See Also
    • Data Access Controls API
      • Endpoint Index
      • See Also
  • Migration API
    • Endpoint Index
    • Migration Management
    • Migration Information

UI SDK

  • Overview
    • Core Philosophy
    • Key Features
    • Installation
    • Documentation
  • EC React Components
    • Core Philosophy
    • Key Features
    • Installation
    • Component Documentation
      • Core Forms
      • Transaction Forms
    • Custom Rendering (Tags for Fields)
    • Theming
    • Documentation
      • AccountForm
        • Usage
        • Props
        • State Management
        • Constraint Evaluation
        • Validation
        • Labels and Translations
      • DraftTransactionForm
        • Usage
        • Props
        • State Management
        • Validation
        • Labels and Translations
      • ElementForm
        • Usage
        • Props
        • State Management
        • Validation
        • Labels and Translations
      • InitializedTransactionForm
        • Usage
        • Props
        • State Management
        • Validation
        • Labels and Translations
      • NewDisbursementForm
        • Usage
        • Props
        • State Management
        • Validation
        • Labels and Translations
      • PaymentForms
        • 1. NewPaymentForm
        • 2. ExistingPaymentForm
        • 3. ReversePaymentForm
      • PolicyForm
        • Usage
        • Props
        • State Management
        • Validation
        • Labels and Translations
      • QuoteForm
        • Usage
        • Props
        • State Management
        • Constraint Evaluation
        • Validation
        • Labels and Translations
      • DataPropertyForm
        • Usage
        • Props
        • State Management
        • Validation
        • Labels and Translations
      • Rendering Customizations
        • Hiding Fields
        • Hiding Fields Conditionally
        • Horizontal Layout for Custom Data Types
        • Multi-Select Dropdown for Arrays
        • Rendering as a Radio Group
        • Displaying Currency Fields
      • Theming
        • Method 1: Theming with Tailwind CSS and shadcn/ui (Recommended)
        • Method 2: Basic CSS Import (Without Tailwind)
        • Method 3: Per-Component Style Overrides (Advanced)
  • EC React Schemas
    • Schemas for the Socotra Insurance Suite
    • Core Philosophy
    • Key Features
      • Installation
      • Usage
      • Documentation
      • Available Schemas
    • Accounts
    • Billings
    • Charges
    • Config
    • Documents
    • Policies
    • Quotes
    • Shared
    • Transactions
  • EC React Utils
    • Utils for the Socotra Insurance Suite
      • Installation
      • Usage
    • Documentation
      • Available Utilities
    • Data Extraction
    • Default Value Getters
    • API Request Builders
    • Miscellaneous
    • Documentation

AI Guide

  • MCP Server Topic Index
    • MCP Server Overview
      • Overview
      • Next Steps
    • MCP Server Tools
      • Account and Policy Management
      • Transaction Management
      • Work Management
      • User and Access Management
      • Search
      • Next Steps
    • MCP Server Installation
      • Prerequisites
      • Installation
        • Cursor
        • Claude
      • Next Steps
    • MCP Server Prompt Examples

Other Resources

  • Release Notes
    • September 10, 2025
      • Data Lake Enhancements
      • Documentation Updates
      • Bug Fixes
    • September 4, 2025
      • New Features: Autopay and Payment Execution Service
      • Other Changes
      • Upcoming Data Lake Enhancements
      • Bug Fixes
    • August 27, 2025
      • Feature Enhancement: Target End State for Excess Credit Distributions
      • New Data Lake Entities
      • Security Documentation Update
      • Bug Fixes
    • August 20, 2025
      • API Docs Cleanup
    • August 13, 2025
      • New Feature: Auto Credit Application
    • August 6, 2025
      • Config Validation Requirement
      • Quote and Transaction Reset Clarification
      • Bug Fixes
    • July 30, 2025
      • New Feature: Schedules (BETA)
      • Feature Enhancement: Granular Write Offs
      • Open API Response Name Change
      • Bug Fixes
    • July 23, 2025
      • Billing Preview for Stateless Quotes
      • Notice: Upcoming Open API Response Name Change
      • Bug Fixes
    • July 16, 2025
      • Installments Plugin
      • Migration Client Release and Updated Guidance
      • New Task Creation Methods
    • July 9, 2025
      • New Feature: Custom Scheduled Events
      • New Feature: Policy Holds
      • Documentation Updates
      • Notice: Autoclean of Abandoned Tenants Introduced to Sandbox
    • July 2, 2025
      • Deprecation: Quote Delinquency Reference
    • June 25, 2025
      • Documentation Updates
      • Notice: Autoclean of Abandoned Tenants to be Introduced to Sandbox
      • Bug Fixes
    • June 18, 2025
      • New Work Management Feature Set
      • Numbering Support for New Entity Types
      • Cancellation at Existing Policy End Time
      • Other Enhancements
      • Bug Fixes
    • June 11, 2025
      • New Document Features: Snippets and Custom Fonts
      • New Data Lake Entities: Claims
      • Documentation Updates
    • June 4, 2025
      • Bug Fixes
    • May 28, 2025
      • Bug Fix: FNOL Numbering
    • May 21, 2025
      • Search Summary Enhancement
      • Bug Fix: Document Consolidation
    • May 14, 2025
      • Policy Locators in Billing Events
      • Bug Fixes
    • May 7, 2025
      • New Feature: Invoice Fees
      • New Diary Associations
      • Update: Numbering
    • April 30, 2025
      • New Feature: Document Consolidation
      • Quick Quotes API Update
      • billingTrigger Deprecation
      • Deprecated Jobs API Endpoints Removed
      • Bug Fixes
    • April 23, 2025
      • Media Data
      • Search Updates
      • Coverage Terms Data Model Update
      • Configuration Redeployment Update
    • April 16, 2025
      • Policy Status
      • Bug Fixes
    • April 9, 2025
      • Search Update
      • More Contact Associations
      • Ad-Hoc Execution of Precommit Plugin
      • Full Stateless Pricing of Quote and Transactions
      • Bug Fixes
    • April 2, 2025
      • Notice: Classic Early Invoicing Endpoint Deprecation
    • March 26, 2025
      • New Features
      • Bug Fixes
    • March 19, 2025
    • March 12, 2025
      • New Feature: Data Lake Delta Files
      • New Data Lake Entities: Billing
      • Configuration Deployments API Update
      • Classic Endpoint List Behavior Deprecation
    • March 5, 2025
      • New Feature: First Notice of Loss
      • New Feature Guides
    • February 26, 2025
      • Bug Fix
    • February 19, 2025
      • Rating Plugin Interface Update
      • Invoices API Update
      • Resource Selection Update
      • Bug Fixes
    • February 12, 2025
      • Policy Transactions API Update
      • Jobs API Endpoint Deprecations
      • Bug Fix
      • Forthcoming Changes
    • February 5, 2025
      • Account Constraints
      • Documents API Update
      • Forthcoming Plugin Interface Changes
    • January 29, 2025
    • January 22, 2025
      • Forthcoming Plugin Interface Changes
      • List Endpoint Semantics Update
    • January 15, 2025
      • Underwriting Event Payload Updates
      • Other Changes
    • January 8, 2025
      • New Feature: Availability
      • New Feature: Contact Management
      • New Static Data Endpoints
      • Underwriting Update
    • December 18, 2024
      • User Management API Update
    • December 11, 2024
      • Migration API update
      • Identity Providers API update
    • December 4, 2024
      • New Feature: Data Lake (Beta)
      • New Feature: Value-Based Coverage Terms
      • Other Changes
      • Bug Fixes
    • November 20, 2024
      • New Feature: Early Invoicing
    • November 13, 2024
      • New Feature: Delinquency Events
    • November 6, 2024
      • Constraint Tables
      • Quote Events
      • Optional Properties
    • October 30, 2024
      • Constraints with Custom Data Types
      • Additional Changes to Paged List Fetch Semantics
      • Deployments
    • October 23, 2024
      • Data Access Controls
      • Webhooks Security Features
      • Yet More Changes to Paged List Fetch Semantics
      • Other Changes
    • October 16, 2024
      • Entity Numbering
      • More Changes to Paged List Fetch Semantics
      • Other Changes
    • October 9, 2024
      • New Feature Guides
      • Other Changes
    • October 2, 2024
    • September 25, 2024
      • New Getting Started Guide!
      • New Migration Feature Guide
      • Invoice Documents
      • Other Changes
    • September 18, 2024
      • External Documents
      • Other Changes
    • Older Changes
  • Deprecated API Items
    • Endpoints
      • POST /auth/identity
      • GET /billing/{tenantLocator}/delinquencies/quotes/{quoteLocator}/list
      • GET /policy/{tenantLocator}/policies/snapshot/list
      • GET /policy/{tenantLocator}/transactions/{locator}/affectedTransactions/list
      • GET /policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}
      • GET /policy/{tenantLocator}/transactions/{locator}/segments/list
    • Entities
      • Account Response
      • Billing Plan Ref
      • Billing Preferences
      • Charge Ref
      • Configuration Ref
      • Document Job Info
      • Document Summary
      • Element Ref
      • Invoice Details Response
      • Migration Billing Preferences
      • Migration Preferences
      • Params Change Instruction Create Request
      • Params Change Instruction Response
      • Policy Response
      • Policy Transaction Response
      • Product Ref
      • Quick Quote Price Response
      • Quote Response
  • Open API Definition File
  • Connected Core Docs
Socotra
  • MCP Server Topic Index

MCP Server Topic Index

  • MCP Server Overview
  • MCP Server Tools
  • MCP Server Installation
  • MCP Server Prompt Examples

© Copyright 2025, Socotra.

Built with Sphinx using a theme provided by Read the Docs
.