Contracts & Agreement Management
Purpose:
Comprehensive contract lifecycle management with digital signature capabilities, document versioning, and automated compliance tracking.
Description:
The contract management system handles the complete lifecycle of legal agreements from creation through termination. It supports complex multi-product contracts, automated workflow processing, digital signature collection, and comprehensive document management. The system maintains version control, tracks amendments, and ensures compliance with regulatory requirements across different jurisdictions.
Contract Operations:
- Multi-step contract enrollment with validation
- Digital signature collection and verification
- Automated contract activation and renewal processing
- Flexible contract modification and termination procedures
- Device assignment and handover tracking for physical products
Document Management:
- Automated document generation from templates
- Version control and change tracking
- Secure document storage and retrieval
- Multi-format document support (PDF, digital signatures, etc.)
Business Value:
Streamlines contract operations, ensures legal compliance, reduces administrative overhead, provides complete audit trails for regulatory requirements, and enables scalable contract processing without proportional increases in manual effort.
POST /v4/contracts
Purpose:
Performs various contract actions including enrollment, acceptance, termination, device assignment, and handover with automated workflow processing.
Endpoint Explanation:
This multi-purpose endpoint handles all contract lifecycle operations through action-based processing. The system supports multiple action types including contract enrollment with comprehensive customer data, contract acceptance with digital signature verification, termination procedures with proper notice and settlement calculations, device assignment for physical product contracts, and handover confirmations for delivery tracking. Each action triggers appropriate business workflows, maintains audit trails, and ensures compliance with legal and regulatory requirements.
Rental Insurance Schema:
- Request (cURL) Rental Product
- Request Payload (JSON) Rental Product
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"configuration": {
"action_id": "enrol",
"market_id": "PL",
"callback_url": "https://webhook.site/279d72c9-da94-4c9a-b76a-62b4cf360f36"
},
"payload": {
"external_references": [
{ "value": "0PR5NLHWM0I5FNG0KK", "type": "partner_reference_id" },
{ "value": "0031000010I01LETC9", "type": "partner_customer_id" }
],
"start_date": "2024-10-29T10:15:20.300Z",
"end_date": "2025-10-29T10:15:20.300Z",
"applicant": {
"additional_details": { "legal_type": "NaturalPerson" },
"addresses": [
{
"type": "main",
"country": "Poland",
"state": "Mazowieckie",
"city": "Warsaw",
"postal_code": "00-001",
"suburb": "Śródmieście",
"street": { "type": "avenue", "name": "Main", "number": "123", "apartment": "45" },
"drop_point_number": "DP12345"
},
{
"type": "delivery",
"country": "Poland",
"state": "Mazowieckie",
"city": "Warsaw",
"postal_code": "00-002",
"street": { "type": "street", "name": "Delivery", "number": "67", "apartment": "8" }
}
]
},
"policy": {
"policy_id": "POL_789456123",
"type": "new_production",
"provider": "BolttechInsurance",
"valid_from": "2023-01-01T00:00:00Z",
"valid_until": "2024-12-31T23:59:59Z"
},
"product": {
"name": "Premium Device Protection",
"product_id": "PROD-DEV-001",
"product_package": "device-insurance"
},
"price": {
"amount": 599.99,
"currency_code": "PLN",
"premium": { "net": 499.99, "total": 599.99 },
"taxes": [
{ "description": "Value Added Tax", "type": "vat", "value": 0.23, "rate": 23 }
],
"discount": [
{
"additional_details": {},
"apply_over_taxes": true,
"type": "fixed",
"value": "string",
"rate": 20,
"commission_value": 0,
"description": "string"
}
],
"commission": {
"additional_details": {},
"apply_over_taxes": true,
"type": "fixed",
"value": "string",
"rate": 20,
"commission_value": 0,
"description": "string"
}
},
"artifacts": [
{
"artifact_id": "BR_123456789",
"name": "TandC.pdf",
"type": "pdf",
"description": "Terms and conditions file",
"value": "https://storage-service/BR_123456789"
}
],
"consentments": [
{ "name": "TERMS_AND_CONDITIONS", "type": "statement", "status": true },
{ "name": "DATA_PROCESSING", "type": "consent", "status": true },
{ "name": "MARKETING_CONSENT", "type": "consent", "status": true }
],
"devices": [
{
"type": "device",
"brand": "Apple",
"model": "iPhone 15 Pro",
"capacity": "256GB",
"color": "Space Black",
"serial_number": "SN234567890",
"purchase_price": 5999.0,
"purchase_date": "2022-12-01T00:00:00Z"
},
{
"type": "device",
"brand": "Samsung",
"model": "Galaxy S23 Ultra",
"capacity": "512GB",
"color": "Phantom Black",
"serial_number": "SN000000001",
"purchase_price": 5499.0,
"purchase_date": "2022-11-15T00:00:00Z"
}
],
"custom_fields": { "field1": "value1", "field2": "value2" },
"status": "active"
}
}'
{
"configuration": {
"action_id": "enrol",
"market_id": "PL",
"callback_url": "https://webhook.site/279d72c9-da94-4c9a-b76a-62b4cf360f36"
},
"payload": {
"external_references": [
{
"value": "0PR5NLHWM0I5FNG0KK",
"type": "partner_reference_id"
},
{
"value": "0031000010I01LETC9",
"type": "partner_customer_id"
}
],
"start_date": "2024-10-29T10:15:20.300+0000",
"end_date": "2025-10-29T10:15:20.300+0000",
"applicant": {
"additional_details": {
"legal_type": "NaturalPerson"
},
"addresses": [
{
"type": "Main",
"country": "Poland",
"state": "Mazowieckie",
"city": "Warsaw",
"postal_code": "00-001",
"suburb": "Śródmieście",
"street": {
"type": "Avenue",
"name": "Main",
"number": "123",
"apartment": "45"
},
"drop_point_number": "DP12345"
},
{
"type": "Delivery",
"partner": {
"country": "Poland",
"additional_details": {},
"state": "Mazowieckie",
"branch": "Warsaw",
"city": "Warsaw",
"brand": "default",
"postal_code": "00-002",
"street": {
"client_id": "PARTNER_456",
"type": "Street",
"name": "Bolttech broker",
"number": "67",
"apartment": "8"
}
}
}
],
"birth_date": "1990-01-01T00:00:00Z",
"citizenship": [
"Polish",
"German"
],
"contact": {
"emails": [
{
"type": "personal",
"value": "[email protected]"
}
],
"phone_numbers": [
{
"area_code": "+48",
"type": "mobile",
"value": "123456789"
}
]
},
"documents": [
{
"type": "passport",
"value": "AB1234567",
"valid_from": "2020-01-01T00:00:00Z",
"valid_to": "2030-01-01T00:00:00Z"
},
{
"type": "id_card",
"value": "POL123456789",
"valid_from": "2018-05-15T00:00:00Z",
"valid_to": "2028-05-15T00:00:00Z"
}
],
"first_name": "John",
"last_name": "Smith",
"nationality": "PL",
"segment": "B2C",
"customer_id": "CUST_12345678",
"verifications": [
{
"type": "IdentityConfirmation",
"provider": "VerifyID",
"result": "PASS",
"data": "Raw verification data in text format",
"report": {
"file_name": "identity_verification.pdf",
"file_content": "base64encodedcontenthere",
"mime_type": "application/pdf"
}
}
],
"finance": {
"income": 5000.00,
"expenses": 3000.00,
"main_income_source": "IndefinedPeriod",
"dependants_count": 2
}
},
"payment": {
"amount": "199.99",
"currency_code": "PLN",
"invoice_number": "INV-2023-001",
"locale": "pl-PL",
"payer": {
"additional_details": {},
"address": {
"city": "Warsaw",
"country": "Poland",
"postal_code": "00-001",
"street": {
"name": "Main",
"number": "123",
"type": "Avenue"
}
},
"first_name": "John",
"last_name": "Smith"
},
"payment_method": "credit_card",
"product_name": "Device Insurance Premium",
"recurrence": "Monthly",
"status": "completed"
},
"rental_details": {
"specific_logistic_method": "HomeDelivery",
"cart": [
{
"pricing_line_id": "PL_123456",
"serial_number": "SN123456789"
},
{
"pricing_line_id": "PL_234567",
"serial_number": "SN234567890"
}
],
"source": "b2c",
"start_date": "2023-01-01T00:00:00Z"
},
"utms": {
"campaign": "winter_promo_2023",
"medium": "email",
"source": "newsletter"
},
"policies": [
{
"dates": {
"current_effective": "2023-01-01T00:00:00Z",
"expiration": "2024-12-31T23:59:59Z",
"initial_effective": "2023-01-01T00:00:00Z",
"issue_date": "2022-12-15T00:00:00Z"
},
"insured": [
{
"additional_details": {},
"info": {
"devices": [
{
"pricing_line_id": "PL_123456",
"serial_number": "SN123456789",
"brand": "Apple",
"model": "iPhone 14 Pro",
"capacity": "256GB",
"color": "Space Black",
"purchase_date": "2022-12-01T00:00:00Z",
"purchase_price": 5999.00
},
{
"pricing_line_id": "PL_234567",
"serial_number": "SN234567890",
"brand": "Samsung",
"model": "Galaxy S23 Ultra",
"capacity": "512GB",
"color": "Phantom Black",
"purchase_date": "2022-11-15T00:00:00Z",
"purchase_price": 5499.00
}
],
"type": "device"
}
}
],
"period": "Annual",
"policy_id": "POL_789456123",
"price": {
"amount": 599.99,
"currency_code": "PLN",
"premium": {
"net": 499.99,
"total": 599.99
},
"taxes": [
{
"description": "Value Added Tax",
"type": "VAT",
"value": 0.23,
"rate": 23
}
]
},
"product": {
"name": "Premium Device Protection",
"product_id": "PROD-DEV-001",
"product_package": "device-insurance"
},
"market": "PL",
"provider": "BolttechInsurance",
"status": "Active",
"type": "New Production",
"valid_from": "2023-01-01T00:00:00Z",
"valid_until": "2024-12-31T23:59:59Z"
}
],
"artifacts": [
{
"artifact_id": "BR_123456789",
"description": "Terms and conditions file",
"name": "TandC.pdf",
"type": "PDF",
"value": "https://storage-service/BR_123456789"
}
],
"consentments": [
{
"name": "MARKETING_CONSENT",
"status": true,
"type": "Consent"
},
{
"name": "TERMS_AND_CONDITIONS",
"status": true,
"type": "Statement"
},
{
"name": "DATA_PROCESSING",
"status": true,
"type": "Consent"
}
],
"custom_fields": {
"field1": "value1",
"field2": "value2"
},
"external_references": [
{
"type": "external_doc_id",
"value": "EXT_123"
},
{
"type": "rental_external_id",
"value": "RENT_98765"
}
],
"status": "Active"
}
}
Car Insurance Schema:
- Request (cURL) Car Insurance Product
- Request Payload (JSON) Car Insurance Product
curl -X POSThttps://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
],
},
{
"additional_details": {
"example_key": "example_value"
},
"devices": [
{
"additional_details": {
"example_key": "example_value"
},
"brand": "string",
"color": "string",
"condition": "New | Used | Refurbished",
"description": "string",
"imei": "string",
"model": "string",
"purchase_date": "datetime",
"recommended_retail_price": {
"amount": "float",
"commission": {
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
},
"currency_code": "ISO 4217 currency code",
"discount": [
{
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
}
],
"premium": {
"net": "float",
"premium": "float"
},
"taxes": {
"description": "string",
"type": "string",
"value": "float",
"rate": "number",
}
},
"serial_number": "string",
"shipping_address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
},
},
"sku": "string",
"storage_size": "string",
"type": "Smartphone | Tablet | Router | Mobile"
}
],
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}'
{
"configuration": {
"action_id": "enroll",
"market_id": "string",
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string"
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string",
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value"
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {},
"questionnaire": {
"answer": "string",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
}
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
],
"drivers": [
{
"class": "Usual | Occasional",
"info": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"license_date": "datetime",
"license_type": "AM | A1 | A2 | A | B | BTP | BE | C1 | C1E | C | CE | D1 | D1E | D | DE"
}
],
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"vehicle": [
{
"accessories": [
{
"description": "string",
"value": "string"
}
],
"additional_details": {
"example_key": "example_value"
},
"brand": "string",
"category": "CA | MO | TU",
"class": "Bus | Car | Motorcycle | Other | Quad | Tractor | Truck | Van",
"color": "string",
"cylinder_capacity": "string",
"description": "string",
"displacement": "number",
"doors": "number",
"fuel": "string",
"horsepower": "number",
"length": "number",
"model": "string",
"price": "number",
"registration": "string, plate number",
"registration_date": "datetime",
"seats": "number",
"transmission": "string",
"use": "AL | CL | EM | OS | PA | SP | NI",
"version": "string",
"weight": "number",
"year": "number"
}
]
}
}
Cyber Protection Product:
- Request (cURL) Cyber Protection Product
- Request Payload (JSON) Cyber Protection Product
curl -X POST https://api.rc.saas.bolttech.asia/v4contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
"monitoring_details": {
"addresses": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"country_code": "Country code with 2 characters (ISO 3166 alpha-2), eg: PT",
"region": "string",
"zip_code": "string"
}
],
"bank_accounts": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string",
"extra": "string"
}
],
"bank_details": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string",
"bic": "string",
"iban": "string"
}
],
"birth_dates": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"brands": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"companies": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_credit_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_duns_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_ein_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_tax_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"credit_cards": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"dental_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"domains": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"driver_licenses": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"emails": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"flyer_cards": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"gamertags": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"ip_addresses": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"loyalty_cards": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"maiden_names": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"medical_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"national_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"partial_bank_accounts": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"passports": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"social_media_handles": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"social_security_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"telephones": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string",
"type": "string"
}
],
"vat_id_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"vehicle_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"vision_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
]
}
}'
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
"monitoring_details": {
"addresses": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"country_code": "Country code with 2 characters (ISO 3166 alpha-2), eg: PT",
"region": "string",
"zip_code": "string"
}
],
"bank_accounts": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string",
"extra": "string"
}
],
"bank_details": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string",
"bic": "string",
"iban": "string"
}
],
"birth_dates": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"brands": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"companies": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_credit_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_duns_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_ein_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"company_tax_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"credit_cards": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"dental_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"domains": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"driver_licenses": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"emails": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"flyer_cards": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"gamertags": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"ip_addresses": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"loyalty_cards": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"maiden_names": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"medical_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"national_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"partial_bank_accounts": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"passports": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"social_media_handles": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"social_security_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"telephones": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string",
"type": "string"
}
],
"vat_id_numbers": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"vehicle_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
],
"vision_insurances": [
{
"creation_date": "datetime",
"key": "string",
"primary": "boolean",
"label": "string",
"value": "string"
}
]
}
}
Device Protection Schema:
- Request (cURL) Device Protection Product
- Request Payload (JSON) Device Protection Product
curl -X POSThttps://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '
{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
],
},
{
"additional_details": {
"example_key": "example_value"
},
"devices": [
{
"additional_details": {
"example_key": "example_value"
},
"brand": "string",
"color": "string",
"condition": "New | Used | Refurbished",
"description": "string",
"imei": "string",
"model": "string",
"purchase_date": "datetime",
"recommended_retail_price": {
"amount": "float",
"commission": {
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
},
"currency_code": "ISO 4217 currency code",
"discount": [
{
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
}
],
"premium": {
"net": "float",
"premium": "float"
},
"taxes": {
"description": "string",
"type": "string",
"value": "float",
"rate": "number",
}
},
"serial_number": "string",
"shipping_address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
},
},
"sku": "string",
"storage_size": "string",
"type": "Smartphone | Tablet | Router | Mobile"
}
],
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}
'
{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
],
},
{
"additional_details": {
"example_key": "example_value"
},
"devices": [
{
"additional_details": {
"example_key": "example_value"
},
"brand": "string",
"color": "string",
"condition": "New | Used | Refurbished",
"description": "string",
"imei": "string",
"model": "string",
"purchase_date": "datetime",
"recommended_retail_price": {
"amount": "float",
"commission": {
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
},
"currency_code": "ISO 4217 currency code",
"discount": [
{
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
}
],
"premium": {
"net": "float",
"premium": "float"
},
"taxes": {
"description": "string",
"type": "string",
"value": "float",
"rate": "number",
}
},
"serial_number": "string",
"shipping_address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
},
},
"sku": "string",
"storage_size": "string",
"type": "Smartphone | Tablet | Router | Mobile"
}
],
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}
Health Insurance Schema:
- Request (cURL) Health Insurance Product
- Request Payload (JSON) Health Insurance Product
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d ' {
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"modality": "string",
"person": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}
'
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"modality": "string",
"person": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}
Home Insurance Schema:
- Request (cURL) Home Insurance Product
- Request Payload (JSON) Home Insurance Product
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"insured": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"property": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"area": "number",
"bathrooms": "number",
"bedrooms": "number",
"constructionMaterial": "string",
"garageCapacity": "number",
"hasBackyard": "boolean",
"hasElevator": "boolean",
"hasParking": "boolean",
"isFurnished": "boolean",
"isRented": "boolean",
"price": "number",
"rooms": "number",
"type": "single_family_semi_detached | individual_single_family | individual_single_couplet | flat_or_apartment | country_house | penthouse | apartment | semi_detached_house | chalet | ground_floor",
"yearBuilt": "number",
}
},
}
'
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"insured": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"property": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"area": "number",
"bathrooms": "number",
"bedrooms": "number",
"constructionMaterial": "string",
"garageCapacity": "number",
"hasBackyard": "boolean",
"hasElevator": "boolean",
"hasParking": "boolean",
"isFurnished": "boolean",
"isRented": "boolean",
"price": "number",
"rooms": "number",
"type": "single_family_semi_detached | individual_single_family | individual_single_couplet | flat_or_apartment | country_house | penthouse | apartment | semi_detached_house | chalet | ground_floor",
"yearBuilt": "number",
}
},
}
Multi-Gadget Insurance Schema:
- Request (cURL) Multi-Gadget Insurance Product
- Request Payload (JSON) Multi-Gadget Product
curl -X POST https://api.rc.saas.bolttech.asia/v4contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"devices": [
{
"additional_details": {
"example_key": "example_value"
},
"brand": "string",
"color": "string",
"condition": "New | Used | Refurbished",
"description": "string",
"imei": "string",
"model": "string",
"operating_system": "string",
"purchase_date": "datetime",
"recommended_retail_price": {
"amount": "float",
"commission": {
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
},
"currency_code": "ISO 4217 currency code",
"discount": [
{
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
}
],
"premium": {
"net": "float",
"premium": "float"
},
"taxes": {
"description": "string",
"type": "string",
"value": "float",
"rate": "number",
}
},
"serial_number": "string",
"shipping_address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
},
},
"sku": "string",
"storage_size": "string",
"type": "Smartphone | Tablet | Router | Mobile"
}
],
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}
'
{
"configuration": {
"action_id": "enrol", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"devices": [
{
"additional_details": {
"example_key": "example_value"
},
"brand": "string",
"color": "string",
"condition": "New | Used | Refurbished",
"description": "string",
"imei": "string",
"model": "string",
"operating_system": "string",
"purchase_date": "datetime",
"recommended_retail_price": {
"amount": "float",
"commission": {
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
},
"currency_code": "ISO 4217 currency code",
"discount": [
{
"additional_details": {
"example_key": "example_value"
},
"apply_over_taxes": "boolean",
"commission_value": "float",
"description": "string",
"type": "FIXED | PERCENTAGE",
"value": "string",
"rate": "number"
}
],
"premium": {
"net": "float",
"premium": "float"
},
"taxes": {
"description": "string",
"type": "string",
"value": "float",
"rate": "number",
}
},
"serial_number": "string",
"shipping_address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
},
},
"sku": "string",
"storage_size": "string",
"type": "Smartphone | Tablet | Router | Mobile"
}
],
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
}
}
Travel Insurance Schema:
- Request (cURL) Travel Insurance
- Request Payload (JSON) Travel Insurance
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"pets": [
{
"additional_details": {
"example_key": "example_value"
},
"birth_date": "datetime",
"breed": "string",
"gender": "string",
"microchip_id": "string",
"name": "string",
"type": "bird | cat | dog | fish | other"
}
]
}
}'
{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"destination": "string",
"travelers": [
{
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
}
]
}
}
Pet Insurance Schema:
- Request (cURL) Pet Insurance
- Request Payload (JSON) Pet Insurance
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '
{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"pets": [
{
"additional_details": {
"example_key": "example_value"
},
"birth_date": "datetime",
"breed": "string",
"gender": "string",
"microchip_id": "string",
"name": "string",
"type": "bird | cat | dog | fish | other"
}
]
}
}
'
{
"configuration": {
"action_id": "enroll", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"agent_id": "string",
"applicant": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"artifacts": [
{
"artifact_id": "string",
"description": "string",
"name": "string",
"type": "MEDIA | PDF | LINK",
"value": "The actual content/URL/file path of the artifact"
}
],
"custom_fields": {
"example_key": "example_value"
},
"end_date": "datetime",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"market": "string",
"partner": {
"additional_details": {
"example_key": "example_value"
},
"branch": "string",
"brand": "string",
"client_id": "string",
"name": "string",
},
"payment": {
"additional_details": {
"example_key": "example_value"
},
"amount": "string",
"currency_code": "ISO 4217 currency code",
"invoice_number": "string",
"locale": "string", // Language and region code in ISO format
"payer": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"payment_account": "string",
"payment_id": "string",
"payment_method": "string",
"product_name": "string",
"recurrence": "Annual | Bimonthly | Daily | Extraordinary | Four Monthly | Monthly | One Time | Quarterly | Semiannual | Weekly",
"recurring_id": "string",
"scope_id": "uuid",
"status": "string"
},
"source": "b2b | b2b2c | b2c | d2c",
"start_date": "datetime",
"utms": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string",
"transaction": "string"
},
"due_date": "datetime",
"insured": [
{
"additional_details": {
"example_key": "example_value",
},
"beneficiary": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known",
"relationship": "string"
},
"info": {
/// depending on the product type (car-insurance, cyber-protection, device-protection, health-insurance, home-insurance, multigadget, travel-insurance, pet-insurance, ticket-insurance)
/// check the line 290
},
"questionnaire": {
"answer": "sring",
"answer_code": "string",
"answer_type": "string",
"description": "string",
"param_code": "string",
"question": "string",
"sub_answer": "string"
},
"type": "car | property | person | company | device | cyber | health | travel | pet"
},
],
"products": [
{
"product_id": "string",
"product_package": "string",
"quote_id": "string"
}
]
},
{
"additional_details": {
"example_key": "example_value"
},
"owner": {
"additional_details": {
"example_key": "example_value"
},
"address": {
"additional_details": {
"example_key": "example_value"
},
"city": "string",
"country": "string",
"floor": "string",
"postal_code": "string",
"province": "string",
"state": "string",
"street": {
"name": "string",
"number": "string",
"type": "string"
}
},
"birth_date": "datetime",
"contact": {
"emails": [
{
"type": "string. eg: main",
"value": "string"
}
],
"phone_numbers": [
{
"area_code": "string. eg: +351",
"type": "string. eg: main",
"value": "string"
}
]
},
"documents": [
[
{
"type": "string. eg: national number",
"value": "string"
}
]
],
"first_name": "string",
"language": "Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes), ex: por or pt",
"last_name": "string",
"middle_name": "string",
"nationality": "Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes), ex: PRT or PT",
"sex": "Gender Enum (ISO/IEC 5218)",
"title": "Mr | Mrs | Sir | Miss | Not known"
},
"pets": [
{
"additional_details": {
"example_key": "example_value"
},
"birth_date": "datetime",
"breed": "string",
"gender": "string",
"microchip_id": "string",
"name": "string",
"type": "bird | cat | dog | fish | other"
}
]
}
}
POST /v4/contracts/action (Contract Acceptance)
Endpoint Explanation: This endpoint allows a activation of a rental pre-contract
- Request (cURL)
- Request Payload (JSON)
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/action \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"configuration": {
"action_id": "activate",
"callback_url": "https://webhook.site/279d72c9-da94-4c9a-b76a-62b4cf360f36"
},
"payload": {
"contract_id": "BR_de3aa01ac5784c25bc881244606bf8b7"
}
}'
{
"configuration": {
"action_id": "accept",
"callback_url": "https://webhook.site/279d72c9-da94-4c9a-b76a-62b4cf360f36"
},
"payload": {
"contract_id": "BR_de3aa01ac5784c25bc881244606bf8b7"
}
}
POST /v4/contracts/action (Termination/Cancel)
Endpoint Explanation: This endpoint allows a cancelation of a contract
- Request (cURL)
- Request Payload (JSON)
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/action \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"configuration": {
"action_id": "cancel", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"additional_details": {
"example_key": "example_value"
},
"canceled_at": "datetime",
"contract_id": "string", // required
"policy_id": "string", // required
"details": "",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"reason": "Cancellation Agreement | Claim | Error | Lack Of Documentation | Loss Experience | Non Payment | Reason Not Available | Replacement | Risk Termination | Transfer | None Of The Above"
}'
"configuration": {
"action_id": "cancel", // required
"market_id": "string", // required
"callback_url": "string"
},
"payload": {
"additional_details": {
"example_key": "example_value"
},
"canceled_at": "datetime",
"contract_id": "string", // required
"policy_id": "string", // required
"details": "",
"external_references": [
{
"type": "documentType",
"value": "documentValue"
}
],
"reason": "Cancellation Agreement | Claim | Error | Lack Of Documentation | Loss Experience | Non Payment | Reason Not Available | Replacement | Risk Termination | Transfer | None Of The Above"
}'
GET /v4/contracts/{contract_id}
Purpose: Retrieves comprehensive contract details including terms, status, and associated products.
Endpoint Explanation: Provides complete contract information including current status, terms and conditions, associated products or services, customer details, payment information, and contract history.
- Request (cURL)
- Response (JSON)
curl -X GET https://api.rc.saas.bolttech.asia/v4/contracts/{contract_id}\
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
{
"contract_id": "BR_de3aa01ac5784c25bc881244606bf8b7",
"contract_number": "58745487",
"status": "active",
"start_date": "2023-01-01T00:00:00Z",
"end_date": "2024-12-31T23:59:59Z",
"applicant": {
"first_name": "John",
"last_name": "Smith",
"phone_number": "+351912345678",
"email": "[email protected]",
"address": {
"street": "123 Main Street",
"city": "Porto",
"province": "Porto",
"postcode": "4100-001",
"country": "Portugal"
}
},
"product": {
"name": "Premium Device Protection",
"product_id": "PROD-DEV-001",
"product_package": "device-insurance"
},
"policy": {
"policy_id": "POL_789456123",
"type": "new_production",
"provider": "BolttechInsurance",
"valid_from": "2023-01-01T00:00:00Z",
"valid_until": "2024-12-31T23:59:59Z"
},
"price": {
"amount": 599.99,
"currency_code": "EUR",
"premium": { "net": 499.99, "total": 599.99 },
"taxes": [
{ "description": "Value Added Tax", "type": "vat", "value": 100.0, "rate": 20 }
]
},
"payment": {
"amount": "599.99",
"currency_code": "EUR",
"payment_method": "credit_card",
"recurrence": "annual",
"status": "completed"
},
"devices": [
{
"brand": "Apple",
"model": "iPhone 15 Pro",
"capacity": "256GB",
"color": "Natural Titanium",
"serial_number": "ABC123XYZ789",
"purchase_date": "2023-01-01T00:00:00Z",
"purchase_price": 1199.0
}
]
}
GET /v4/contracts/{contract_id}/documents
Purpose: Lists all documents associated with contract including policies and amendments.
Endpoint Explanation: [Rental only] Provides an inventory of contract-related documentation with versioning and secure download metadata.
- Request (cURL)
- Response (JSON)
curl -X GET https://api.rc.saas.bolttech.asia/v4/contracts/{contract_id}/documents\
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
{
"documents": [
{ "id": "DOC_123456789", "name": "Device Protection Policy", "type": "contract", "kind": "policy_document" },
{ "id": "DOC_234567890", "name": "Terms and Conditions", "type": "contract", "kind": "terms_conditions" },
{ "id": "DOC_345678901", "name": "Privacy Policy", "type": "contract", "kind": "privacy_policy" },
{ "id": "DOC_456789012", "name": "Payment Receipt", "type": "payment_doc", "kind": "payment_confirmation" }
]
}
GET /v4/contracts/{contract_id}/documents/{document_id}
Purpose: Downloads a specific contract document with metadata and version information.
Endpoint Explanation: [Rental only] Provides secure access to individual documents with creation dates, versioning, signatures, and access history.
- Request (cURL)
- Response (JSON)
curl -X GET https://api.rc.saas.bolttech.asia/v4/contracts/{contract_id}/documents/{document_id}\
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
{
"id": "DOC_123456789",
"name": "Device Protection Policy",
"content": "base64encodedcontenthere",
"type": "contract",
"encrypted": false,
"metadata": {
"created_at": "2023-01-01T10:00:00Z",
"version": "1.0",
"file_size": "245KB",
"mime_type": "application/pdf",
"checksum": "sha256:a1b2c3d4e5f6.",
"digital_signature": {
"signed": true,
"signature_date": "2023-01-01T10:05:00Z",
"signer": "BolttechInsurance",
"signature_valid": true
}
},
"access_history": [
{ "accessed_by": "system_user", "access_time": "2023-01-01T10:00:00Z", "action": "created" },
{ "accessed_by": "customer_portal", "access_time": "2023-01-02T15:30:00Z", "action": "downloaded" }
]
}
Add a device to a contract
POST /v4/contracts/action (Add Device to a Contract)
Endpoint Explanation: [Rental Only] Adds a new device to an existent pre-contract
- Request (cURL)
- Request Payload (JSON)
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/action \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"contract_id": "ABC123",
"configuration_action_id": "device_assignment",
"payload_contract_id": "XYZ456",
"contract_elements": [
{
"number": 1,
"serial_number": "SN12345678",
"imei": "990000862471854"
}
]
}'
{
"contract_id": "ABC123",
"configuration_action_id": "device_assignment",
"payload_contract_id": "XYZ456",
"contract_elements": [
{
"number": 1,
"serial_number": "SN12345678",
"imei": "990000862471854"
}
]
}
- Response Payload (JSON)
{
"status": "success",
"message": "Device successfully assigned to contract",
"data": {
"contract_id": "ABC123",
"action_id": "device_assignment",
"timestamp": "2025-05-16T14:30:45Z",
"contract_elements": [
{
"number": 1,
"serial_number": "SN12345678",
"imei": "990000862471854",
"status": "assigned"
}
],
"transaction_id": "txn-789012"
}
}
Customer Scoring for Contract
POST /v4/contracts/action (Customer Scoring)
Endpoint Explanation:
[Rental Only] Provides status & decision regarding credit scoring process for a specific rental contract
Approval_status - Approval status with possible values: None, Positive, Negative, Disable, ConditionalPositive, Error, FinancialLimitExceeded, FinancialLimitPerDeviceExceeded, QuantitativeLimitExceeded available_limit_for_offer - Internal limit for customer
- Request (cURL)
- Request Payload (JSON)
curl -X POST https://api.rc.saas.bolttech.asia/v4/contracts/action \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"configuration": {
"action_id": "check_approval_status",
"market_id": "string",
"callback_url": "string"
},
"payload": {
"contract_id": "string"
}
}'
{
"configuration": {
"action_id": "check_approval_status",
"market_id": "string",
"callback_url": "string"
},
"payload": {
"contract_id": "string"
}
}
- Response Payload (JSON)
{ "approvalStatus": "None", "availableLimitForOffer": 0 }
Notes
- All endpoints require
Authorization: Bearer <token>.