> For the complete documentation index, see [llms.txt](https://docs.insurehero.io/shield-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.insurehero.io/shield-api/data-dictionary.md).

# Data Dictionary

The Data Dictionary provides a detailed reference of the database structure and API data fields used in the system. It includes information about each field's name, description, data type, constraints, and example values. This document ensures consistency in data handling, facilitates development, and improves maintainability.

## **Authentication**

<table><thead><tr><th width="163">Name</th><th width="95">Type</th><th>Description</th></tr></thead><tbody><tr><td>Authorization<mark style="color:red;">*</mark></td><td>string</td><td>Bearer access token</td></tr></tbody></table>

## **Policies**

<table><thead><tr><th width="230">Name</th><th width="117">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>uuid</td><td>Unique identifier for the policy.</td></tr><tr><td>created_at</td><td>timestamp</td><td>Date and time when the policy was created.</td></tr><tr><td>deleted_at</td><td>timestamp</td><td>Date and time when the policy was deleted (null if active).</td></tr><tr><td>updated_at</td><td>timestamp</td><td>Date and time when the policy was last updated.</td></tr><tr><td>version</td><td>smallint</td><td>Version number of the policy record.</td></tr><tr><td>channel_id</td><td>uuid</td><td>Identifier of the channel through which the policy was issued.</td></tr><tr><td>holder_id</td><td>uuid</td><td>Identifier of the policyholder.</td></tr><tr><td>uid</td><td>string</td><td>Unique alphanumeric identifier for the policy.</td></tr><tr><td>policy_number</td><td>string</td><td>Policy number.</td></tr><tr><td>total_gross_price</td><td>string</td><td>Total cost of the policy</td></tr><tr><td>subject_schema</td><td>jsonb</td><td>JSON schema defining the insured subject's details.</td></tr><tr><td>coverages</td><td>jsonb</td><td>JSON object listing the coverages included in the policy.</td></tr><tr><td>product</td><td>jsonb</td><td>JSON object containing details of the insurance product.</td></tr><tr><td>metadata</td><td>jsonb</td><td>JSON object for storing additional policy-related information.</td></tr><tr><td>features</td><td>jsonb</td><td>JSON object defining specific policy features.</td></tr><tr><td>attachments</td><td>jsonb</td><td>JSON object containing relevant policy attachments.</td></tr><tr><td>max_rescission_window</td><td>string</td><td>Maximum time window allowed for policy cancellation.</td></tr></tbody></table>

## **Claims:**

<table><thead><tr><th width="218">Name</th><th width="139">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>uuid</td><td>Unique identifier for the claim.</td></tr><tr><td>created_at</td><td>timestamp</td><td>Date and time when the claim was created.</td></tr><tr><td>updated_at</td><td>timestamp</td><td>Date and time when the claim was last updated.</td></tr><tr><td>deleted_at</td><td>timestamp</td><td>Date and time when the claim was deleted (null if active).</td></tr><tr><td>risk_item_id</td><td>uuid</td><td>Identifier of the risk item.</td></tr><tr><td>claimant_id</td><td>uuid</td><td>Identifier of the person or entity making the claim.</td></tr><tr><td>channel_id</td><td>uuid</td><td>Identifier of the channel.</td></tr><tr><td>subject</td><td>string</td><td>Subject of the claim.</td></tr><tr><td>insurer_claim_number</td><td>string</td><td>Claim number assigned by the insurer.</td></tr><tr><td>internal_claim_number</td><td>string</td><td>Internal claim reference number.</td></tr><tr><td>status</td><td>string</td><td>Current status of the claim (e.g., pending, approved, rejected).</td></tr><tr><td>incident_date</td><td>timestamp</td><td>Date and time when the incident occurred.</td></tr><tr><td>resolution_date</td><td>timestamp</td><td>Date and time when the claim was resolved.</td></tr><tr><td>claim_amount</td><td>numeric</td><td>Amount claimed by the policyholder.</td></tr><tr><td>payout_amount</td><td>numeric</td><td>Amount approved for payout.</td></tr><tr><td>metadata</td><td>jsonb</td><td>JSON object storing additional claim-related data.</td></tr><tr><td>assets</td><td>jsonb</td><td>JSON object containing relevant claim-related assets.</td></tr><tr><td>type</td><td>tex</td><td>type of claim.</td></tr><tr><td>consent_date</td><td>timestamp</td><td>Date and time when the claimant gave consent.</td></tr><tr><td>incident</td><td>jsonb</td><td>JSON object detailing the incident related to the claim.</td></tr><tr><td>package_id</td><td>uuid</td><td>Identifier of the insurance package related to the claim.</td></tr><tr><td>transaction_date</td><td>timestamp</td><td>Date and time of the financial transaction related to the claim.</td></tr><tr><td>uid</td><td>string</td><td>Unique alphanumeric identifier for the claim.</td></tr><tr><td>variant_id</td><td>uuid</td><td>Identifier of the policy variant related to the claim.</td></tr><tr><td>assignee_id</td><td>uuid</td><td>Identifier of the person assigned to handle the claim.</td></tr><tr><td>claimant_data</td><td>jsonb</td><td>JSON object storing the claimant’s personal and contact details.</td></tr><tr><td>policy_reference</td><td>jsonb</td><td>JSON object containing policy details referenced in the claim.</td></tr><tr><td>required_documents</td><td>jsonb</td><td>JSON object listing the documents required for claim processing.</td></tr><tr><td>owner_id</td><td>uuid</td><td>Identifier of the entity or person who owns the claim record.</td></tr><tr><td>current_step</td><td>string</td><td>Indicates the current step of the claim process.</td></tr><tr><td>workflow</td><td>jsonb</td><td>JSON object defining the workflow stages of the claim process.</td></tr><tr><td>information_collected</td><td>jsonb</td><td>JSON object containing collected information during the claim process.</td></tr></tbody></table>

## **Risk Items**

<table><thead><tr><th width="163">Name</th><th width="113">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>uuid</td><td>Unique identifier for the risk item.</td></tr><tr><td>created_at</td><td>timestamp</td><td>Date and time when the risk item was created.</td></tr><tr><td>updated_at</td><td>timestamp</td><td>Date and time when the risk item was last updated.</td></tr><tr><td>deleted_at</td><td>timestamp</td><td>Date and time when the risk item was deleted (null if active).</td></tr><tr><td>package_id</td><td>uuid</td><td>Identifier of the related package.</td></tr><tr><td>channel_id</td><td>uuid</td><td>Identifier of the communication channel related to the risk item.</td></tr><tr><td>start_date</td><td>timestamp</td><td>Start date of the risk item.</td></tr><tr><td>end_date</td><td>timestamp</td><td>End date of the risk item.</td></tr><tr><td>status</td><td>string</td><td>Current status of the risk item.</td></tr><tr><td>metadata</td><td>jsonb</td><td>JSON object containing additional information related to the risk item.</td></tr><tr><td>authorized_claimants</td><td>jsonb</td><td>JSON object containing authorized claimants for the risk item.</td></tr><tr><td>assets</td><td>jsonb</td><td>JSON object containing assets related to the risk item.</td></tr><tr><td>insured_subject</td><td>jsonb</td><td>JSON object with details about the insured subject of the risk item.</td></tr><tr><td>beneficiaries</td><td>jsonb</td><td>JSON object containing information about beneficiaries related to the risk item.</td></tr><tr><td>policy_id</td><td>uuid</td><td>Identifier of the related policy for the risk item.</td></tr><tr><td>uid</td><td>string</td><td>Unique identifier for the risk item.</td></tr><tr><td>identifier_type</td><td>string</td><td>Type of identifier used for the risk item.</td></tr><tr><td>identifier_value</td><td>string</td><td>Value of the identifier used for the risk item.</td></tr></tbody></table>

## **Users**

<table><thead><tr><th width="257">Name</th><th width="120">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>uuid</td><td>Unique identifier for the user.</td></tr><tr><td>created_at</td><td>timestamp</td><td>Date and time when the user was created.</td></tr><tr><td>updated_at</td><td>timestamp</td><td>Date and time when the user was last updated.</td></tr><tr><td>deleted_at</td><td>timestamp</td><td>Date and time when the user was deleted (null if active).</td></tr><tr><td>first_name</td><td>string</td><td>User's first name.</td></tr><tr><td>last_name</td><td>string</td><td>User's last name.</td></tr><tr><td>email</td><td>string</td><td>User's email address.</td></tr><tr><td>uid</td><td>string</td><td>Unique alphanumeric identifier for the user.</td></tr><tr><td>channel_id</td><td>uuid</td><td>Identifier of the communication channel linked to the user.</td></tr><tr><td>phone</td><td>string</td><td>User’s phone number.</td></tr><tr><td>dob</td><td>string</td><td>User’s date of birth.</td></tr><tr><td>document_type</td><td>string</td><td>Type of identification document (e.g., passport, ID card).</td></tr><tr><td>document_number</td><td>string</td><td>Identification document number.</td></tr><tr><td>gender</td><td>string</td><td>User's gender (e.g., male, female, non-binary).</td></tr><tr><td>address</td><td>jsonb</td><td>JSON object containing user’s address details.</td></tr><tr><td>metadata</td><td>jsonb</td><td>JSON object containing additional user data.</td></tr><tr><td>bank_accounts</td><td>jsonb</td><td>JSON object storing user’s bank accounts.</td></tr><tr><td>company_name</td><td>string</td><td>Name of the company the user is associated with.</td></tr><tr><td>company_role</td><td>string</td><td>User's role within the company.</td></tr><tr><td>company_email</td><td>string</td><td>Company-related email address of the user.</td></tr><tr><td>company_identifier</td><td>jsonb</td><td>JSON object containing company identifiers.</td></tr><tr><td>company_address</td><td>jsonb</td><td>JSON object storing company address details.</td></tr><tr><td>company_bank_accounts</td><td>jsonb</td><td>JSON object containing the company’s bank accounts.</td></tr><tr><td>group_id</td><td>uuid</td><td>Identifier of the group the user belongs to.</td></tr></tbody></table>

## **Orders**

<table><thead><tr><th width="181">Name</th><th width="121">Type</th><th>Description (English)</th></tr></thead><tbody><tr><td>id</td><td>uuid</td><td>Unique identifier for the order.</td></tr><tr><td>created_at</td><td>timestamp</td><td>Timestamp of when the order was created.</td></tr><tr><td>channel_id</td><td>uuid</td><td>ID of the channel through which the order was placed.</td></tr><tr><td>customer_id</td><td>uuid</td><td>ID of the customer associated with the order.</td></tr><tr><td>customer_data</td><td>jsonb</td><td>Additional customer information.</td></tr><tr><td>status</td><td>string</td><td>Current status of the order.</td></tr><tr><td>status_data</td><td>jsonb</td><td>Additional data related to the order status.</td></tr><tr><td>total_gross_price</td><td>string</td><td>Total gross price of the order.</td></tr><tr><td>total_net_price</td><td>string</td><td>Total net price of the order.</td></tr><tr><td>total_taxes</td><td>string</td><td>Total taxes applied to the order.</td></tr><tr><td>channel_gross_price</td><td>string</td><td>Gross price charged by the channel.</td></tr><tr><td>channel_net_price</td><td>string</td><td>Net price received by the channel.</td></tr><tr><td>channel_taxes</td><td>string</td><td>Taxes applied to the channel's share.</td></tr><tr><td>platform_gross_price</td><td>string</td><td>Gross price received by the platform.</td></tr><tr><td>platform_net_price</td><td>string</td><td>Net price received by the platform.</td></tr><tr><td>platform_taxes</td><td>string</td><td>Taxes applied to the platform's share.</td></tr><tr><td>insurer_gross_price</td><td>string</td><td>Gross price received by the insurer.</td></tr><tr><td>insurer_net_price</td><td>string</td><td>Net price received by the insurer.</td></tr><tr><td>insurer_taxes</td><td>string</td><td>Taxes applied to the insurer's share.</td></tr><tr><td>risk_item_id</td><td>uuid</td><td>ID of the associated risk item.</td></tr></tbody></table>

## **Claims Events**

| Name        | Type                     | Description                                 |
| ----------- | ------------------------ | ------------------------------------------- |
| id          | uuid                     | Unique identifier for the event.            |
| created\_at | timestamp with time zone | Timestamp when the event was created.       |
| updated\_at | timestamp with time zone | Timestamp when the event was last updated.  |
| deleted\_at | timestamp with time zone | Timestamp when the event was deleted.       |
| metadata    | jsonb                    | Additional metadata related to the event.   |
| claim\_id   | uuid                     | ID of the associated claim.                 |
| channel\_id | uuid                     | ID of the channel where the event occurred. |
| event\_data | jsonb                    | Details about the event.                    |
| uid         | text                     | Unique identifier for the event (custom).   |

## **Risk Items Events**

| Name           | Type      | Description                                 |
| -------------- | --------- | ------------------------------------------- |
| id             | uuid      | Unique identifier for the event.            |
| created\_at    | timestamp | Timestamp when the event was created.       |
| updated\_at    | timestamp | Timestamp when the event was last updated.  |
| deleted\_at    | timestamp | Timestamp when the event was deleted.       |
| metadata       | jsonb     | Additional metadata related to the event.   |
| risk\_item\_id | uuid      | ID of the associated risk item.             |
| channel\_id    | uuid      | ID of the channel where the event occurred. |
| event\_data    | jsonb     | Details about the event.                    |
| uid            | string    | Unique identifier for the event.            |

#### **Error Handling**