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
Authorization*
string
Bearer access token
Policies
id
uuid
Unique identifier for the policy.
created_at
timestamp
Date and time when the policy was created.
deleted_at
timestamp
Date and time when the policy was deleted (null if active).
updated_at
timestamp
Date and time when the policy was last updated.
version
smallint
Version number of the policy record.
channel_id
uuid
Identifier of the channel through which the policy was issued.
holder_id
uuid
Identifier of the policyholder.
uid
string
Unique alphanumeric identifier for the policy.
policy_number
string
Policy number.
total_gross_price
string
Total cost of the policy
subject_schema
jsonb
JSON schema defining the insured subject's details.
coverages
jsonb
JSON object listing the coverages included in the policy.
product
jsonb
JSON object containing details of the insurance product.
metadata
jsonb
JSON object for storing additional policy-related information.
features
jsonb
JSON object defining specific policy features.
attachments
jsonb
JSON object containing relevant policy attachments.
max_rescission_window
string
Maximum time window allowed for policy cancellation.
Claims:
id
uuid
Unique identifier for the claim.
created_at
timestamp
Date and time when the claim was created.
updated_at
timestamp
Date and time when the claim was last updated.
deleted_at
timestamp
Date and time when the claim was deleted (null if active).
risk_item_id
uuid
Identifier of the risk item.
claimant_id
uuid
Identifier of the person or entity making the claim.
channel_id
uuid
Identifier of the channel.
subject
string
Subject of the claim.
insurer_claim_number
string
Claim number assigned by the insurer.
internal_claim_number
string
Internal claim reference number.
status
string
Current status of the claim (e.g., pending, approved, rejected).
incident_date
timestamp
Date and time when the incident occurred.
resolution_date
timestamp
Date and time when the claim was resolved.
claim_amount
numeric
Amount claimed by the policyholder.
payout_amount
numeric
Amount approved for payout.
metadata
jsonb
JSON object storing additional claim-related data.
assets
jsonb
JSON object containing relevant claim-related assets.
type
tex
type of claim.
consent_date
timestamp
Date and time when the claimant gave consent.
incident
jsonb
JSON object detailing the incident related to the claim.
package_id
uuid
Identifier of the insurance package related to the claim.
transaction_date
timestamp
Date and time of the financial transaction related to the claim.
uid
string
Unique alphanumeric identifier for the claim.
variant_id
uuid
Identifier of the policy variant related to the claim.
assignee_id
uuid
Identifier of the person assigned to handle the claim.
claimant_data
jsonb
JSON object storing the claimant’s personal and contact details.
policy_reference
jsonb
JSON object containing policy details referenced in the claim.
required_documents
jsonb
JSON object listing the documents required for claim processing.
owner_id
uuid
Identifier of the entity or person who owns the claim record.
current_step
string
Indicates the current step of the claim process.
workflow
jsonb
JSON object defining the workflow stages of the claim process.
information_collected
jsonb
JSON object containing collected information during the claim process.
Risk Items
id
uuid
Unique identifier for the risk item.
created_at
timestamp
Date and time when the risk item was created.
updated_at
timestamp
Date and time when the risk item was last updated.
deleted_at
timestamp
Date and time when the risk item was deleted (null if active).
package_id
uuid
Identifier of the related package.
channel_id
uuid
Identifier of the communication channel related to the risk item.
start_date
timestamp
Start date of the risk item.
end_date
timestamp
End date of the risk item.
status
string
Current status of the risk item.
metadata
jsonb
JSON object containing additional information related to the risk item.
authorized_claimants
jsonb
JSON object containing authorized claimants for the risk item.
assets
jsonb
JSON object containing assets related to the risk item.
insured_subject
jsonb
JSON object with details about the insured subject of the risk item.
beneficiaries
jsonb
JSON object containing information about beneficiaries related to the risk item.
policy_id
uuid
Identifier of the related policy for the risk item.
uid
string
Unique identifier for the risk item.
identifier_type
string
Type of identifier used for the risk item.
identifier_value
string
Value of the identifier used for the risk item.
Users
id
uuid
Unique identifier for the user.
created_at
timestamp
Date and time when the user was created.
updated_at
timestamp
Date and time when the user was last updated.
deleted_at
timestamp
Date and time when the user was deleted (null if active).
first_name
string
User's first name.
last_name
string
User's last name.
string
User's email address.
uid
string
Unique alphanumeric identifier for the user.
channel_id
uuid
Identifier of the communication channel linked to the user.
phone
string
User’s phone number.
dob
string
User’s date of birth.
document_type
string
Type of identification document (e.g., passport, ID card).
document_number
string
Identification document number.
gender
string
User's gender (e.g., male, female, non-binary).
address
jsonb
JSON object containing user’s address details.
metadata
jsonb
JSON object containing additional user data.
bank_accounts
jsonb
JSON object storing user’s bank accounts.
company_name
string
Name of the company the user is associated with.
company_role
string
User's role within the company.
company_email
string
Company-related email address of the user.
company_identifier
jsonb
JSON object containing company identifiers.
company_address
jsonb
JSON object storing company address details.
company_bank_accounts
jsonb
JSON object containing the company’s bank accounts.
group_id
uuid
Identifier of the group the user belongs to.
Orders
id
uuid
Unique identifier for the order.
created_at
timestamp
Timestamp of when the order was created.
channel_id
uuid
ID of the channel through which the order was placed.
customer_id
uuid
ID of the customer associated with the order.
customer_data
jsonb
Additional customer information.
status
string
Current status of the order.
status_data
jsonb
Additional data related to the order status.
total_gross_price
string
Total gross price of the order.
total_net_price
string
Total net price of the order.
total_taxes
string
Total taxes applied to the order.
channel_gross_price
string
Gross price charged by the channel.
channel_net_price
string
Net price received by the channel.
channel_taxes
string
Taxes applied to the channel's share.
platform_gross_price
string
Gross price received by the platform.
platform_net_price
string
Net price received by the platform.
platform_taxes
string
Taxes applied to the platform's share.
insurer_gross_price
string
Gross price received by the insurer.
insurer_net_price
string
Net price received by the insurer.
insurer_taxes
string
Taxes applied to the insurer's share.
risk_item_id
uuid
ID of the associated risk item.
Claims Events
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
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
Last updated