Topics on this page

BriteAPI Tutorial: Retrieve, update, and display policy information (Classic)

BriteCore offers a policy administration system used to execute core processes such as rating, underwriting, binding, issuing, endorsing, canceling/rescinding cancelation, reinstating, and renewing policies. It’s the system of record for all policies written by an insurance carrier.

This tutorial guides you through retrieving, updating, and displaying BriteCore policy information (Classic BriteCore) using APIs to populate your Policies dashboard.

We also cover the key concepts to understand policies in BriteCore, including policies process flow, policy revisions, and status.

Note: For auto-related policy information, refer to the BritePolicies tutorial.

Key concepts

  • Coverage: A guarantee of financial restoration in the event of a loss.
  • Endorsement transactions: Revisions to the inforce policies.
  • Inception to date (ITD): ITD includes historical policy data and inforce data.
  • Inforce policies: Insurance policies that are currently under contract.
  • Policy: A contract that guarantees insurance coverage for a given duration of time.
  • Premium: Money paid by a policyholder to an insurance carrier in exchange for insurance.
  • Risk: An asset protected by insurance.

Policies process flow

In BriteCore, a policy’s status depends on where it is in the policy life cycle. Figure 1 outlines a policy’s flow from the policy application submission to active policies, including possible transactions on an active policy.

Figure 1: A policy’s flow.

Policy revisions in BriteCore

A revision is the foundation of a policy and tracks the changes to a policy over time, including written premium. The following revision states indicate whether the revision’s information is in effect:

  • Committed: The data associated with the revision is in effect and can be reported on.
  • Open: The data associated with the revision is in progress and, therefore, isn’t in effect and can’t be reported on.
  • Pending: The data associated with the revision is in progress and isn’t in effect and can’t be reported on.
  • Archived: The data associated with the revision was at one time in effect and can be reported on.

Using BriteAPIs to set up a Policies dashboard

This section will walk you through specific API endpoints to select for your Policies dashboard.

Step 1: Get a security token

You will need to request an ID and Secret to use OAuth 2.0.

For more information, refer to How do I get started?

Step 2: Search policies

Pass a string to the Search endpoint to retrieve a list of matching policies.

Sample request

View code
curl --location --request POST '/api/v2/policies/search' \

--header 'Content-Type: application/json' \

--header 'Authorization: \

--header 'Cookie: webpy_session_id=50065e09d3fee0247ea293caba306ea8ae75b534' \

--data-raw '--data-raw '\''{

"search_string": "",

"sort_obj":{

"field":"effective_date",

"order":"asc"

},

"current_page":1,

"page_size":25

}'\''

'

Sample response

View code
"FlatCancel",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "f17925d1-f0b1-45fb-872f-fde748e6c201",

"expirationDate": "01/06/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/13/2019",

"policyNumber": "Endorse02",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "a5242cba-aebf-45f4-bcfd-4ded1ad40114",

"expirationDate": "01/13/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/15/2019",

"policyNumber": "Endorse01",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "60ec8a75-c1d0-43be-b601-ad79fc4d712b",

"expirationDate": "01/15/2020"

},

{

"status": "Unsubmitted",

"namedInsured": "Joe Insured",

"effectiveDate": "01/16/2019",

"policyNumber": "P-2019-7",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Commercial Umbrella",

"policyId": "783addab-072a-48bb-8e29-f44d4b6d2246",

"expirationDate": "01/16/2020"

},

{

"status": "Unsubmitted",

"namedInsured": "Joe Insured",

"effectiveDate": "01/17/2019",

"policyNumber": "P-2019-9",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Personal Inland Marine",

"policyId": "61ab60ad-c60a-42c6-85a9-834a7f3e8324",

"expirationDate": "01/17/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/17/2019",

"policyNumber": "Endorse03",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "ce94d4e1-d614-4cd3-aeb4-c0ddef4d1b52",

"expirationDate": "01/17/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/20/2019",

"policyNumber": "Endorse05",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "48c4bb13-f041-4663-b997-76b93353cba4",

"expirationDate": "01/20/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/21/2019",

"policyNumber": "Endorse06",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "ad46ac6c-53b0-4deb-9aac-05c75eb89947",

"expirationDate": "01/21/2020"

},

{

"status": "Active",

"namedInsured": "",

"effectiveDate": "01/24/2019",

"policyNumber": "P-2019-11",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners By Peril",

"policyId": "c972b20c-6a65-479a-b9e8-7cb8f6d4db2e",

"expirationDate": "01/24/2020"

},

{

"status": "Active",

"namedInsured": "Madeline Schamberger",

"effectiveDate": "01/24/2019",

"policyNumber": "P-2019-10",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners By Peril",

"policyId": "3b99c8d3-3841-43cd-8bed-9ad7673bbff1",

"expirationDate": "01/24/2020"

},

{

"status": "Unsubmitted",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "10-2019-1",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners By Peril",

"policyId": "29d7f944-6a80-4ae9-b7c1-1ea191ee7076",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "10-2019-2",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 2",

"policyId": "7db8b1c4-e3c1-44f8-9e14-2ed3c8115aab",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "P-2019-13",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 2",

"policyId": "9323da3f-6cb3-48b0-8ac4-6b739fd81542",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "P-2019-12",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 2",

"policyId": "478b0c48-207d-4666-8ba0-51900638f30f",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "New_Business",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "bdcadea4-4aea-481b-a523-10a509d7a5ac",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "OverPay",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "db638245-0eff-483d-b127-fe7ea1f2095f",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "UnderPay",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "b5edd0f3-e0d1-49b1-af3a-3f50d5812dbd",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "NSFPay",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "5eb7daf2-6c7b-4b83-946c-9949c8787580",

"expirationDate": "02/01/2020"

},

{

"status": "Canceled",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "MidCancel",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "aace7a72-3d81-4d5a-b19d-a7ee7e7be9c1",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "AgencyBill",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "3994b493-e6c3-4790-881c-3cead217d904",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "02/05/2019",

"policyNumber": "Q-2019-4",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Commercial Package",

"policyId": "8b430839-e3a7-47be-85a0-893931509530",

"expirationDate": "02/05/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "02/06/2019",

"policyNumber": "P-2019-14",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Personal Inland Marine",

"policyId": "8380c653-c11c-4a6c-a16d-b9552806d3c1",

"expirationDate": "02/06/2020"

}

]

},

"messages": [],

"success": true

}

Step 3: Create contact

You can make a POST request to the new_contact endpoint to create a new contact in BriteCore and, optionally, their related emails, mailing addresses, and phone numbers. You must pass a body request that includes:

View code
{
"name":"Test Agency Inc",
"doing_business_as":"TA Inc.",
"type":"organization",
"phones":[{
"phone": "1-111-1111",
"type": "Work"
}],
"emails":[{
"email": "person@domain.com",
"type": "Work"
}],
"addresses":[{
"address_line1": "123 Main",
"address_city": "Springfield",
"address_state": "MO",
"address_zip": "12345",
"address_country": "USA",
"type": "Mailing/Billing"
}],
"roles":[{
"name":"Agency"
}]
}

Sample request

View code
curl --location --request POST 'https:///api/v2/contacts/new_contact' \

--headers 'authorization: enter your access token here' \

--'Content-Type: application/json' \

--data-raw '{

"name":"Test Agency Inc",

"doing_business_as":"TA Inc.",

"type":"organization",

"phones":[{

"phone": "1-111-1111",

"type": "Work"

}],

"emails":[{

"email": "person@domain.com",

"type": "Work"

}],

"addresses":[{

"address_line1": "123 Main",

"address_city": "Springfield",

"address_state": "MO",

"address_zip": "12345",

"address_country": "USA",

"type": "Mailing/Billing"

}],

"roles":[

"Agency"

]

}'

Sample response

View code
{

"data": {

"phones": [

{

"phone": "1-111-1111",

"type": "Work",

"id": "c9167f88-9b1e-4cd5-9f52-374fbd1e00e6"

}

],

"addresses": [

{

"address_city": "Springfield",

"address_line1": "123 Main",

"address_state": "MO",

"type": "Mailing/Billing",

"address_county": null,

"address_country": "USA",

"id": "20553542-74dc-4f4a-9549-c40d4aacd69a",

"address_zip": "12345"

}

],

"contact_id": "42e654cb-1f3d-45dc-a014-4e472240b69f",

"emails": [

{

"type": "Work",

"id": "9e71d4c3-41f3-43f8-9aae-8727a0836596",

"email": "person@domain.com"

}

]

},

"messages": [],

"success": true

}

Step 4: Retrieve contact information

The get_contact endpoint allows you to retrieve contact information through their contact_id.

Sample request

View code
curl --location --request POST 'https:///api/v2/contacts/get_contact' \

--header 'Content-Type: application/json' \

--header 'Authorization: \

--data-raw '{

"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"

}'

Sample response

View code
{

"data": {

"display_agency_group_info_on_dec": false,

"mfa": false,

"ssn_group": "59",

"dba": "",

"email_print_list": false,

"commission_account_id": null,

"agency_inception_date": null,

"date_updated": "2020-05-30 03:15:16",

"is_god": false,

"api_key": null,

"sweep_account_id": null,

"follow_agency_quoting_restriction": true,

"issue_payments_account_id": null,

"ssn": "444-33-2222",

"background": null,

"date_added": "2020-02-07 09:25:22",

"agency_termination_date": null,

"password": null,

"fein_tax": null,

"emails": [

{

"date_updated": "2020-02-07 09:26:30",

"type": "Home",

"id": "a4ec857c-8927-4792-8e2b-04d85d0e4b4c",

"contact_id": "55557e45-f96a-482b-bc76-579166abf31c",

"email": "test.namedinsured@fakeemail.com"

}

],

"photo_id": null,

"name": "Test Namedinsured",

"naic_number": "",

"gender": null,

"agency_inactive_timestamp": null,

"comm_statement_email_id": null,

"default_state_id": null,

"phones": [

{

"date_updated": "2020-02-07 09:26:16",

"phone": "(555) 307-2210",

"type": "Home",

"id": "53838495-b63b-4822-b179-629578398da2",

"contact_id": "55557e45-f96a-482b-bc76-579166abf31c"

}

],

"date_business_started": null,

"agency_number": null,

"disallow_e2_val": false,

"is_approved_vendor": false,

"default_agency_id": "",

"termination_reason": null,

"agency_group_number": null,

"notify_of_overdue_invoices": false,

"last_login": null,

"producer_number": null,

"added_by": null,

"do_not_print_when_bill_whom": false,

"active": true,

"agency_billing_enabled": false,

"oops_email": null,

"permission_level_id": null,

"commission_structure": null,

"legal_entity_type": "",

"cc_claim_email_notices": null,

"addresses": [

{

"address_line2": "",

"address_city": "Laramie",

"address_line1": "987 1st Ave",

"type_label": "",

"date_updated": "2020-02-07 09:26:04",

"type": "Mailing/Billing",

"address_county": "Albany County",

"contact_id": "55557e45-f96a-482b-bc76-579166abf31c",

"longitude": null,

"attention": "",

"address_state": "WY",

"latitude": null,

"address_country": "USA",

"id": "83953100-773c-4409-af86-2554f77cdb9b",

"address_zip": "82070"

}

],

"cc_email_notices": "",

"risk_id_number": "",

"mfa_counter": 0,

"terminated": false,

"vendor_number": null,

"issue_commission_payments": false,

"email_notices": true,

"type": "individual",

"website": null,

"system_tags": {},

"flag": "white",

"mfa_code": "MMW2U456JLL3IW4P",

"has_sweep_account": false,

"cognito_username": null,

"claim_activity_email_id": "a4ec857c-8927-4792-8e2b-04d85d0e4b4c",

"accept_electronic_comm_statement": false,

"credit_score_account": null,

"terms_conditions_accepted": false,

"username": null,

"direct_application_activity_to": null,

"timezone": null,

"id": "55557e45-f96a-482b-bc76-579166abf31c",

"issue_payments": false,

"portal_code": "390135",

"purchase_date": null,

"notice_email_id": "a4ec857c-8927-4792-8e2b-04d85d0e4b4c",

"perils": [

{

"date_updated": "2018-11-16 13:16:06",

"code": "01",

"id": "10de285e-e9d4-11e8-a4be-0e509f7061a6",

"name": "Accidental Discharge/Leakage",

"aplus_code": "ACCDL"

},

{

"date_updated": "2018-11-16 13:16:06",

"code": "02",

"id": "10de2932-e9d4-11e8-a4be-0e509f7061a6",

"name": "Appliance Related Water",

"aplus_code": "APPL"

},

{

"date_updated": "2018-11-16 13:16:06",

"code": "03",

"id": "10de2995-e9d4-11e8-a4be-0e509f7061a6",

"name": "Bodily Injury Liability - Non-Auto",

"aplus_code": "BINONAUTO"

},

{

"date_updated": "2018-11-16 13:16:06",

"code": "04",

"id": "10de29b7-e9d4-11e8-a4be-0e509f7061a6",

"name": "Boiler and Machinery",

"aplus_code": "BOILER"

},

{

"date_updated": "2018-11-16 13:16:06",

"code": "05",

"id": "10de29d4-e9d4-11e8-a4be-0e509f7061a6",

"name": "Business Owners Policy",

"aplus_code": "BOP"

},

],

"agency_inactive": false,

"password_attempts": 0,

"is1099_reportable": false,

"drivers_license": "444-33-2222",

"same_as_ssn": true,

"info_for_new_payment_method": {

"cards": {

"AmericanExpress": true,

"VISA": true,

"Discover": true,

"MasterCard": true

},

"options": {

"ach": true,

"avs": true,

"cvv2": true

}

},

"confirmation_email": null,

"dob": "1995-01-01 00:00:00",

"payment_methods": [],

"mortgagee_statement": null,

"position": ""

},

"messages": [

"Retrieved contact information."

],

"success": true

}

Step 5: Retrieve a contact’s policies

You can use the get_policies endpoint to retrieve a contact’s policies by passing the contact_id.

View code
curl --location --request POST 'https:///api/v2/policies/get_policies' \

--header 'Content-Type: application/json' \

--header 'authorization: enter your access token here' \

--data-raw '{

"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"

}'

Sample response

View code
{

"data": {

"include_policy_photo": true,

"from_date": null,

"sorting_order": "asc",

"to_date": null,

"policies": [

{

"next_policy_term_has_payments": false,

"submit_bound": false,

"copied_to_rev_id": null,

"date_updated": "2019-09-26 07:08:09",

"policy_term": {

"manual_reason": null,

"override_min_amount_due": null,

"date_updated": "2019-11-08 12:36:37",

"generate_pre_pay_schedule": true,

"bill_sched_id": "7d3461be-f426-4ba5-8a14-82cc2af82689",

"first_address_used_id": null,

"renewal_status": "Renew",

"email_used_id": null,

"is_renewal": false,

"term_type": "3 Months",

"id": "56d40418-4928-41d6-adcc-a08fc5d9dcff",

"auto_pay_days_before": 0,

"term_length": 92,

"renewal_status_description": null,

"renewal_type": null,

"first_bill_whom_id": null,

"effective_date": "2019-08-01",

"renewal_status_reason_id": null,

"first_email_used_id": null,

"term_credit_score": null,

"address_used_id": "a6ea00e4-180a-4486-af34-b2121e8aac55",

"auto_payment_method_id": "0251f13d-86ee-4421-90bc-aa12217d7d7e",

"has_write_off": false,

"policy_term_number": "",

"first_payment_method_id": null,

"expiration_date": "2019-11-01",

"bill_whom_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",

"first_bill_checked": false,

"force_comm_recalc": true,

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"

},

"ar_details": {

"next_due": "0.00",

"due_date": "10/01/2019",

"previous_due": "0.00",

"next_due_date": "--",

"current_due": "12.00",

"cancel_date": "10/16/2019",

"canceled_on_date": null,

"show_unbilled_amounts": false

},

"inception_date": "2019-08-01",

"policy_group_id": null,

"submit_receipt_email": null,

"current_due": "12.00",

"id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9",

"rewritten": false,

"policy_number": "10-2019-181",

"current_policy_term_has_payments": true,

"payoff_amount": "12.00",

"submit_confirm_name": null,

"show_app": true,

"photo": null,

"do_not_automatically_rewrite": false,

"billing_schedules": [

{

"automatic_payment_reminder": false,

"billing_schedule": "Annual",

"id": "c72d80d5-bb9b-4cd5-925d-b50853b374bd"

}

],

"agent_contact_id": "c0e9a609-deed-4552-bea4-0d2ca1ed3543",

"revision": {

"last_visited": null,

"create_date": "2019-09-30 09:28:44",

"date_updated": "2019-10-01 21:58:47",

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"policy_type_id": "af706bcf-b569-4c72-a041-215a709e3f2a",

"revision_state": "pending",

"id": "3895aba8-7251-451e-b9d7-d0d036a3b5c7",

"builder_pending": false,

"primary_property_id": "85c6eab2-7ca8-4cf2-84f9-c3d09e86d7ae",

"annual_fee": 0,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": 0,

"revision_date": "2019-08-01",

"annual_premium": 523,

"policy_type": "Builders Risk Single Shot",

"named_insureds": [

{

"photo_file_id": null,

"name": "Joe Test",

"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"

}

],

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"deleted": false,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 523,

"policy_status": "Active",

"date_archived": null,

"cancel_date": null,

"written_premium_delta": 0,

"dec_description": null,

"commission_rate": 0,

"commit_date": "2019-10-01",

"policy_term_id": "56d40418-4928-41d6-adcc-a08fc5d9dcff",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"

},

"detailed_can_change_billing_schedule": {

"evaluations": [

[

"has_poor_payment_history",

false

],

[

"policy_cycle_disallows_mid_term_changes",

false

],

[

"has_undue_renewal_invoice_in_date_range",

false

]

],

"reason": "policy_cycle_disallows_mid_term_changes",

"result": true

},

"can_change_billing_schedule": true,

"can_change_billing_schedule_current_term_ba": true,

"system_tags": null,

"agency_contact_id": "8b12e14b-f2cc-47a8-b8d5-b71c7b96919c",

"current_term": {

"manual_reason": null,

"override_min_amount_due": null,

"date_updated": "2019-11-08 12:36:37",

"generate_pre_pay_schedule": true,

"bill_sched_id": "7d3461be-f426-4ba5-8a14-82cc2af82689",

"first_address_used_id": null,

"renewal_status": "Renew",

"email_used_id": null,

"is_renewal": false,

"term_type": "3 Months",

"id": "56d40418-4928-41d6-adcc-a08fc5d9dcff",

"auto_pay_days_before": 0,

"term_length": 92,

"renewal_status_description": null,

"renewal_type": null,

"first_bill_whom_id": null,

"effective_date": "2019-08-01",

"renewal_status_reason_id": null,

"first_email_used_id": null,

"term_credit_score": null,

"address_used_id": "a6ea00e4-180a-4486-af34-b2121e8aac55",

"auto_payment_method_id": "0251f13d-86ee-4421-90bc-aa12217d7d7e",

"has_write_off": false,

"policy_term_number": "",

"first_payment_method_id": null,

"expiration_date": "2019-11-01",

"bill_whom_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",

"first_bill_checked": false,

"force_comm_recalc": true,

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"

},

"flag": "white",

"claims": [

{

"date_updated": "2019-10-02 11:04:12",

"cat_id": "f5eaf761-99c3-4546-be8b-8243b22e9585",

"loss_address_line1": null,

"additional_information": {},

"loss_address_line2": null,

"county": null,

"loss_address_listed": true,

"loss_address_state": null,

"subrogation_reserve": 0,

"id": "3e238c05-221b-4d03-a068-401d0e082b2a",

"loss_date": "2019-09-15 00:00:00",

"iso_transaction_type": "individual",

"type": "property",

"salvage_reserve": 0,

"status": "Open, Standard",

"description": null,

"loss_address": {

"addressState": "LA",

"countySpecification": "",

"addressCounty": "55dd70fe-e778-43e3-9171-ed804cf65d8b",

"addressLine2": null,

"addressLine1": "306 E Miller Ave",

"addressCity": "Iowa",

"addressZip": "70647"

},

"system_tags": null,

"type_manual": false,

"loss_address_city": null,

"flag": "white",

"last_modified": "2019-10-01",

"active": true,

"date_added": "2019-10-01 20:22:30",

"reinsurance_reserve": 0,

"dual_masthead": false,

"county_specify": null,

"last_rein_report_date": null,

"reinsurance_monitor_status": "system-off",

"claim_number": "20-2019-83",

"loss_address_zip": null,

"loss_address_id": "85c6eab2-7ca8-4cf2-84f9-c3d09e86d7ae",

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"

}

],

"active": true,

"date_added": "2019-09-26 06:59:55",

"properties": [

{

"property_group_id": null,

"replace_loss": null,

"property_val": null,

"date_updated": "2019-10-01 11:58:14",

"photo": null,

"inspection_requested_date": null,

"county_specify": "",

"address_state": "LA",

"protection_class_id": null,

"hydrant_distance": 1000,

"id": "85c6eab2-7ca8-4cf2-84f9-c3d09e86d7ae",

"address_line2": null,

"annual_fee": 0,

"address_line1": "306 E Miller Ave",

"replacement_cost_value": null,

"copy_address": false,

"iso_pc_data": null,

"address_country": "USA",

"written_fee": 0,

"risk_data": null,

"loss_history_report_content": null,

"annual_premium": 523,

"latitude": 30.245912,

"type": null,

"replace_contents": null,

"address_accuracy": "great",

"deleted": false,

"address_county": "55dd70fe-e778-43e3-9171-ed804cf65d8b",

"written_premium": 523,

"approved_limits": null,

"flag": "white",

"fire_district_distance": 0,

"loss_history_report_number": null,

"date_added": "2019-09-26 06:59:55",

"revision_id": "3895aba8-7251-451e-b9d7-d0d036a3b5c7",

"inspection_vendor": null,

"address_zip": "70647",

"address_city": "Iowa",

"prefill_services_data": null,

"year_built": null,

"name": "Property 1",

"gross_area": null,

"date_added_micro": 145470,

"longitude": -93.010953,

"next_inspection_date": null,

"stories": null,

"builder_ready_to_rate": false,

"replace_other": null

}

],

"next_policy_term_id": null,

"policy_number_origin": "v1",

"submit_confirm_email": null,

"sequence_id": null,

"account_number": null,

"submit_receipt_name": null,

"policy_number_normalized": "102019181",

"copied_from_rev_id": null

}

],

"page_number": 1,

"page_size": 50,

"total_pages": 1,

"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"

},

"messages": [],

"success": true

}

Step 6: Retrieve your policy summary

Use retrieve_policy_terms to obtain the details of your policy. policy_number and policy_id are required.

Sample request

View code
curl --location --request POST '/api/v2/policies/retrieve_policy_terms' \

--header 'Content-Type: application/json' \
--header 'authorization: enter your access token here' \
--data-raw '{

"policy_number": "P-2020-10",

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

}'

Sample response

View code
{

"data": [

{

"manual_reason": "",

"renewal_status_reason_id": "c105440e-981e-11de-8406-000c2976c0ee",

"revisions": [

{

"commission_rate_adjustment": 0.0000,

"commit_date_time": null,

"last_visited": null,

"create_date": "2020-06-12 13:56:22",

"date_updated": "2020-06-12 13:56:22",

"cancellation_revision_id": null,

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"previous_revision_state": null,

"policy_type_id": "63e5c1f3-4488-4762-96c4-f8b54a2e4345",

"revision_state": "open",

"id": "8194ed51-12ec-49cc-aafd-d087cb3b0662",

"builder_pending": false,

"primary_property_id": "0e54d4d2-8708-4605-b772-aad0ed110a4f",

"annual_fee": 35.00,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": 35.00,

"revision_date": "2020-06-12",

"annual_premium": 25.00,

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 25.00,

"policy_status": "Active",

"date_archived": null,

"cancel_date": null,

"written_premium_delta": 0.00,

"dec_description": null,

"commission_rate": 0.0000,

"commit_date": null,

"policy_term_id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

},

{

"commission_rate_adjustment": 0.0000,

"commit_date_time": "2020-06-12 13:52:53",

"last_visited": null,

"create_date": "2020-06-12 13:51:31",

"date_updated": "2020-06-12 13:56:22",

"cancellation_revision_id": null,

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"previous_revision_state": null,

"policy_type_id": "63e5c1f3-4488-4762-96c4-f8b54a2e4345",

"revision_state": "pending",

"id": "b70e73fe-a07d-4902-b923-027bc807c8a0",

"builder_pending": false,

"primary_property_id": "7a227ea3-003b-4cf0-9ca5-1599a4c9e215",

"annual_fee": 35.00,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": 35.00,

"revision_date": "2020-06-12",

"annual_premium": 25.00,

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 25.00,

"policy_status": "Active",

"date_archived": null,

"cancel_date": null,

"written_premium_delta": 0.00,

"dec_description": "Testing",

"commission_rate": 0.0000,

"commit_date": "2020-06-12",

"policy_term_id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

},

{

"commission_rate_adjustment": 0.0000,

"commit_date_time": null,

"last_visited": null,

"create_date": "2020-06-12 13:04:59",

"date_updated": "2020-06-12 13:51:31",

"cancellation_revision_id": null,

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"previous_revision_state": null,

"policy_type_id": "63e5c1f3-4488-4762-96c4-f8b54a2e4345",

"revision_state": "archived",

"id": "d4a5afca-557f-4bed-846d-bdcedc23ba58",

"builder_pending": false,

"primary_property_id": "4afbd01b-ac1e-474e-9bea-68058aeb4248",

"annual_fee": null,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": null,

"revision_date": "2020-06-12",

"annual_premium": 0.00,

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 0.00,

"policy_status": "Active",

"date_archived": "2020-06-12 13:51:31",

"cancel_date": null,

"written_premium_delta": 0.00,

"dec_description": null,

"commission_rate": 0.0000,

"commit_date": null,

"policy_term_id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

}

],

"term_length": 365,

"expiration_date": "2021-06-12",

"renewal_type": null,

"renewal_status": "Non-Renewal",

"effective_date": "2020-06-12",

"is_renewal": false,

"term_type": "1 Year",

"id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"renewal_status_description": "Credit score is low.",

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

}

],

"messages": [],

"success": true

}

Step 7: Generate and attach a document

The create_deliverable endpoint generates a specified deliverable type and stores it in the Attachments module. S3 file paths are returned, the last part of the response is the File GUID.

Sample request

View code
curl --location --request POST '/api/v1/deliverables/create_deliverable' \

--header 'Content-Type: application/json' \

--header 'authorization: enter your access token here' \

--data-raw '{

"revision_id": "d2218f31-3389-480a-a57e-4e6ddb8ddb83",

"deliverable_type": "Insured Letter",

"go_date": "20191203"

}'

Sample response

View code
{

"data": {

"deliverable_url": {

"url": "uploads/policies/b5/b55084cf-582d-4550-a775-b834ad29f383/731a80a6-a31b-441a-9f42-b3cc928b4759/d5a51c8f-e938-499a-b41f-33e053ccf5d8",

"path": "/srv/www/britecore/uploads/policies/b5/b55084cf-582d-4550-a775-b834ad29f383/731a80a6-a31b-441a-9f42-b3cc928b4759/d5a51c8f-e938-499a-b41f-33e053ccf5d8"

}

},

"messages": [

"Deliverable created"

],

"success": true

}

Step 8: Retrieve the deliverable list

The list_attachments endpoint retrieves all the deliverables (attachments) listed under the policy or contact.

Sample request

View code
curl --location --request POST 'https:///api/v2/deliverables/list_attachments' \

--header 'Content-Type: application/json' \

--header 'authorization : ' \

--data-raw '{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383"

}'

Sample response

View code
{

"data": [

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "0c08b4ef-c966-4cc5-b503-2baf17536149",

"print_date": null,

"title": "Initial Billing Statement"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "300fb14e-e5a0-4288-896d-54d519441048",

"print_date": null,

"title": "Quote Summary"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "3368cbe2-ad71-4ced-890d-08f323d3219a",

"print_date": null,

"title": "11-22-2019 - Compiled"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "6b8e6def-f353-4bda-ae69-39e3c31bf7dc",

"print_date": null,

"title": "Declaration"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "6de43b85-dc87-4e89-8b92-e26bef4e14ce",

"print_date": null,

"title": "11-22-2019 - Declaration"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "89563c92-49b8-4dfc-b0a7-48c454dc3c57",

"print_date": null,

"title": "11-22-2019 - Declaration"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "920a1d62-ebae-49a8-a4d6-e566aa2530d7",

"print_date": null,

"title": "Private"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "9322cd77-26e3-437d-9b25-e0867f0209bf",

"print_date": null,

"title": "Compiled"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "b455862d-699f-4306-8b99-0257aa5b9ad6",

"print_date": null,

"title": "11-07-2026 - Initial Billing Statement"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "e2e7b197-a530-43d3-813c-0cfa6bb83e5c",

"print_date": null,

"title": "11-22-2019 - Compiled"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "e54f3c93-d09f-4c00-87ea-c11a1405b179",

"print_date": null,

"title": "11-22-2026 - Declaration"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": null,

"id": "ef9af80b-589c-4bc4-99ba-0f1c4deb573d",

"print_date": null,

"title": "11-22-2019 - Quote Summary"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Declaration",

"id": "30e313fa-14f5-4220-99bf-173bd2b00acf",

"print_date": "2019-11-25",

"title": "11-22-2019 - Declaration - Anderson, Walker & Reichert, LLP"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Quote Summary",

"id": "92da6b2f-b0ad-464a-bc5b-d7a9add40a36",

"print_date": "2019-11-25",

"title": "11-22-2019 - Quote Summary - Anderson, Walker & Reichert, LLP"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Compiled",

"id": "b54a1479-72c6-4dbd-8bcf-d33e998ce5ea",

"print_date": "2019-11-25",

"title": "11-22-2019 - Compiled - "

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Compiled",

"id": "b67eea82-221f-4323-a37f-03a83e9641f0",

"print_date": "2019-11-25",

"title": "11-22-2019 - Compiled - "

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Declaration",

"id": "b73be2f6-2f69-44dd-a62f-e72488002282",

"print_date": "2019-11-25",

"title": "11-22-2019 - Declaration - Anderson, Walker & Reichert, LLP"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Initial Billing Statement",

"id": "2f0ccdbf-70c0-4840-b2f7-ffc9e7535e9f",

"print_date": "2026-11-09",

"title": "11-07-2026 - Initial Billing Statement - Anderson, Walker & Reichert, LLP"

},

{

"policy_id": "b55084cf-582d-4550-a775-b834ad29f383",

"label": "Initial Billing Statement",

"id": "96d4f255-6125-42ce-98e8-b3b7d553f636",

"print_date": "2026-11-09",

"title": "11-07-2026 - Initial Billing Statement - LPL Embroker Insurance Services LLC"

}

],

"messages": [],

"success": true

}

Step 9: Retrieve a specific deliverable

Use the get_attachment to retrieve a specific deliverable.

Note: The endpoint returns a Base64 encoded payload of your PDF. You need the file_id for the attachment.

Sample request

View code
curl --location --request POST 'https:///api/v2/deliverables/get_attachment' \

--header 'Content-Type: application/json' \

--header 'authorization: enter your access token' \

--data-raw '{

"file_id": "101a3037-d83d-49c2-8991-9144b8b0f868"

}'

Sample response

View code
{

"data": {

"content": "JVBERi0xLjMKJeLjz9MKMSAwIG9iago8PC9BdXRob3IgPD4gL0NyZWF0aW9uRGF0ZSAoRDoyMDIw\nMDUyNzIzMjUwNS0wNScwMCkgL0tleXdvcmRzIDw+CiAgL1Byb2R1Y2VyIChXZWFzeVByaW50IDAu\nNDEgXChodHRwOi8vd2Vhc3lwcmludC5vcmcvXCkpIC9UaXRsZQogIChJbnN1cmVkIExldHRlcik+\nPgplbmRvYmoKMiAwIG9iago8PC9QYWdlcyAzIDAgUiAvVHlwZSAvQ2F0YWxvZz4+CmVuZG9iagoz\nIDAgb2JqCjw8L0NvdW50IDEgL0tpZHMgWzQgMCBSXSAvVHlwZSAvUGFnZXM+PgplbmRvYmoKNCAw\nIG9iago8PC9Bbm5vdHMKICBbPDwvQSA8PC9TIC9VUkkgL1R5cGUgL0FjdGlvbiAvVVJJIChodHRw\nOi8vd3d3LmJyaXRlY29yZS5jb20pPj4gL0JvcmRlcgogIFswIDAgMF0gL1JlY3QgWzQ3My4yMzI0\nMjE4NzUgNjQyLjM2Njc5Njg3NSA1NDkuNzUgNjI5Ljc2Njc5Njg3NV0KICAvU3VidHlwZSAvTGlu\nayAvVHlwZSAvQW5ub3Q+Pl0KICAvQmxlZWRCb3ggWzAgMCA2MTIgNzkyXSAvQ29udGVudHMgNSAw\nIFIgL0dyb3VwCiAgPDwvQ1MgL0RldmljZVJHQiAvSSB0cnVlIC9TIC9UcmFuc3BhcmVuY3kgL1R5\ncGUgL0dyb3VwPj4gL01lZGlhQm94CiAgWzAgMCA2MTIgNzkyXSAvUGFyZW50IDMgMCBSIC9SZXNv\ndXJjZXMgNiAwIFIgL1RyaW1Cb3ggWzAgMCA2MTIgNzkyXQogIC9UeXBlIC9QYWdlPj4KZW5kb2Jq\nCjUgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZSAvTGVuZ3RoIDI5IDAgUj4+CnN0cmVhbQp4\nnI1T207bQBB936+Yt0KF17O73ltVVWooqkBCDUmkPpQ+GMcJoYlNHKPQv++s17kIqESirHYmc85c\nzqwApG8i6LBeQrFia7aGdJi3bdlUUGwgfTSwKSpIc4T5hoVwI2QX3ZQwYzfsBtbMSC41xFNY5Jm1\nkBnuUISon1ARb+833sWk4f8dBD1HHdLHNJA+W/hW9+TYxTfzXQ2DCaMKYuESpJLcSqON7GnQOgET\nopolmCDQfcZO4HTywHwEeSpNESaAQEjkOjPO6h4j9phBs2jL85oauKw2T01eFWVgOeZNBKdsxmVU\nCs8Qhc1gMmUnUlE74/qpvYfBMi/+rPIKRtOAFlx5FF70AIOuA4wfm0U1ny3K5fQMrn+A0Q59iL+Y\nxP65V+ETxkD9HzqxikuVKSpfaMeV9mrfyaH77XbL70I3BXXDi3r1FvPoO901bMl7Rb8H9us3ORCm\nTCBcwxpElzSeJFWfmvJ6rkmIFejM866Q6FjCGG4O6h2XvY/8b8mdYAK58N6i7dXem/3aOOTWv6nd\n1VNVAqozkCjxpWpEJblAlFlUa1DffdjAZVHCeVPmKxjf14+f75r0i5AKrvNFBeO2Kcu28w3qTVtX\nJNJXQCkieUeI3jsjOsLRxScY1stF8ReGSaggoaW/PUGdSpsGG9oa9pa4Pe31CNuuTWhNizAfjZIU\nwXDtn9HLtxCjlaUwmj+N0/bWcmdFJjKPeJdw/x6k5EfAaLzAzT6+44XSOhAis9wZK5x7pdUwn5d0\nrWcgXr0vDNCEGOKS0Gz3A93NjP0DC3sQVgplbmRzdHJlYW0KZW5kb2JqCjYgMCBvYmoKPDwvRXh0\nR1N0YXRlIDw8L2EwIDw8L0NBIDEgL2NhIDE+Pj4+IC9Gb250IDw8L2YtMC0wIDcgMCBSIC9mLTEt\nMCA4IDAgUj4+CiAgL1BhdHRlcm4gPDwvcDYgOSAwIFI+PiAvWE9iamVjdCA8PC94NyAxMCAwIFI+\nPj4+CmVuZG9iago3IDAgb2JqCjw8L0Jhc2VGb250IC9JVUlJWFIrSGVsdmV0aWNhIC9FbmNvZGlu\nZyAvV2luQW5zaUVuY29kaW5nIC9GaXJzdENoYXIgMzIKICAvRm9udERlc2NyaXB0b3IgMjQgMCBS\nIC9MYXN0Q2hhciAxMjEgL1N1YnR5cGUgL1RydWVUeXBlIC9Ub1VuaWNvZGUKICAyNSAwIFIgL1R5\ncGUgL0ZvbnQgL1dpZHRocwogIFsyNzcgMCAwIDAgMCAwIDAgMTkwIDMzMyAzMzMgMCAwIDI3NyAz\nMzMgMjc3IDI3NyA1NTYgNTU2IDU1NiA1NTYgMCA1NTYKICA1NTYgNTU2IDU1NiA1NTYgMjc3IDAg\nNTgzIDAgNTgzIDAgMCA2NjYgNjY2IDcyMiAwIDY2NiAwIDAgMCAyNzcgMCAwIDAKICA4MzMgMCA3\nNzcgNjY2IDAgNzIyIDY2NiAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDU1NiA1NTYgNTAwIDU1\nNiA1NTYKICAyNzcgNTU2IDU1NiAyMjIgMCA1MDAgMjIyIDgzMyA1NTYgNTU2IDU1NiAwIDMzMyA1\nMDAgMjc3IDU1NiAwIDcyMiAwCiAgNTAwXT4+CmVuZG9iago4IDAgb2JqCjw8L0Jhc2VGb250IC9S\nRURNREQrSGVsdmV0aWNhLUJvbGQgL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcgL0ZpcnN0Q2hh\ncgogIDMyIC9Gb250RGVzY3JpcHRvciAxOSAwIFIgL0xhc3RDaGFyIDExNyAvU3VidHlwZSAvVHJ1\nZVR5cGUgL1RvVW5pY29kZQogIDIwIDAgUiAvVHlwZSAvRm9udCAvV2lkdGhzCiAgWzI3NyAwIDAg\nMCAwIDAgMCAwIDAgMCAwIDAgMjc3IDAgMCAwIDU1NiA1NTYgNTU2IDU1NiAwIDAgMCAwIDAgMCAw\nIDAgMAogIDAgMCAwIDAgMCA3MjIgNzIyIDAgMCAwIDAgMCAyNzcgNTU2IDAgMCAwIDAgMCA2NjYg\nMCAwIDAgMCAwIDAgMCAwIDAgMAogIDAgMCAwIDAgMCAwIDU1NiAwIDU1NiAwIDU1NiAzMzMgNjEw\nIDAgMjc3IDAgMCAwIDAgNjEwIDYxMCAwIDAgMzg5IDU1NgogIDMzMyA2MTBdPj4KZW5kb2JqCjkg\nMCBvYmoKPDwvQkJveCBbMCAwIDE2MzIgMjExMl0gL0xlbmd0aCAxMiAwIFIgL01hdHJpeCBbMC43\nNSAwIDAgLTAuNzUgMCA3OTJdCiAgL1BhaW50VHlwZSAxIC9QYXR0ZXJuVHlwZSAxIC9SZXNvdXJj\nZXMgPDwvWE9iamVjdCA8PC94MTAgMTMgMCBSPj4+PgogIC9UaWxpbmdUeXBlIDEgL1hTdGVwIDE2\nMzIgL1lTdGVwIDIxMTI+PgpzdHJlYW0KIC94MTAgRG8gCgplbmRzdHJlYW0KZW5kb2JqCjEwIDAg\nb2JqCjw8L0JpdHNQZXJDb21wb25lbnQgOCAvQ29sb3JTcGFjZSAvRGV2aWNlUkdCIC9GaWx0ZXIg\nL0RDVERlY29kZSAvSGVpZ2h0CiAgNDE3IC9JbnRlcnBvbGF0ZSB0cnVlIC9MZW5ndGggMTEgMCBS\nIC9TdWJ0eXBlIC9JbWFnZSAvVHlwZSAvWE9iamVjdAogIC9XaWR0aCAxNTE5Pj4Kc3RyZWFtCv/Y\n/+AAEEpGSUYAAQEAAAEAAQAA/9sAQwAIBgYHBgUIBwcHCQkICgwUDQwLCwwZEhMPFB0aHx4dGhwc\nICQuJyAiLCMcHCg3KSwwMTQ0NB8nOT04MjwuMzQy/9sAQwEJCQkMCwwYDQ0YMiEcITIyMjIyMjIy\nMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIy/8AAEQgBoQXvAwEiAAIR\nAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAAB\nfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5\nOkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeo\nqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMB\nAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYS\nQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNU\nVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5\nusLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/aAAwDAQACEQMRAD8A9/ooooAK\nKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoo\nooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiii\ngAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKA\nCiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoo

Step 10: Display the declaration preview

The get_dec endpoint generates a declaration on the fly and streams it back in the response. It doesn’t store the generated file. It returns a list of Base64 encoded files.

Sample request

View code
curl --location --request POST 'https:///api/v2/deliverables/get_dec' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"revision_id": "3e3777ba-23d4-4cf2-aeb3-0b9236cc9966",

"policy_id": "2ed922b5-ead9-44fd-839b-e08f58c8d4db"

}'

Sample response

View code
{

“files”: [

“JVBERi0xLjQNCiWTjIueIFJlcG9ydExhYiBHZW5lcmF0ZWQgUERGIGRvY3VtZW50IGh0dHA6Ly93\nd3cucmVwb3J0bGFiLmNvbQ0KJSAnQmFzaWNGb250cyc6IGNsYXNzIFBERkRpY3Rpb25hcnkgDQox\nIDAgb2JqDQolIFRoZSBzdGFuZGFyZCBmb250cyBkaWN0aW9uYXJ5DQo8PCAvRjEgMiAwIFINCiAv\nRjIgNCAwIFINCiAvRjMgNSAwIFINCiAvRjQgNiAwIFINCiAvRjUgOCAwIFINCiAvRjYgOSAwIFIg\nPj4NCmVuZG9iag0KJSAnRjEnOiBjbGFzcyBQREZUeXBlMUZvbnQgDQoyIDAgb2JqDQolIEZvbnQg\nSGVsdmV0aWNhDQo8PCAvQmFzZUZvbnQgL0hlbHZldGljYQ0KIC9FbmNvZGluZyAvV2luQW5zaUVu\nY29kaW5nDQogL05hbWUgL0YxDQogL1N1YnR5cGUgL1R5cGUxDQogL1R5cGUgL0ZvbnQgPj4NCmVu\nZG9iag0KJSAnRm9ybVhvYi41OGQzNGY2YThkNWRlNzU0M2VjNDJiZGYwMWExYjdiMSc6IGNsYXNz\nIFBERkltYWdlWE9iamVjdCANCjMgMCBvYmoNCjw8IC9CaXRzUGVyQ29tcG9uZW50IDgNCiAvQ29s\nb3JTcGFjZSAvRGV2aWNlUkdCDQogL0ZpbHRlciBbIC9BU0NJSTg1RGVjb2RlDQogL0ZsYXRlRGVj\nb2RlIF0NCiAvSGVpZ2h0IDU0DQogL0xlbmd0aCAxOTgxDQogL1N1YnR5cGUgL0ltYWdlDQogL1R5\ncGUgL1hPYmplY3QNCiAvV2lkdGggMTg5ID4+DQpzdHJlYW0NCkdiIi9saGVObS4nWl40aT9bVkZo\nLWMkJHA3LjxWSmQyKilwcVZtLGtMXjU0KFcxWltNVWAnZFAuXF1maihAI0w7RyJaJm5END5fJzoi\nKm9uUClZR20pQiwqNFVlMTFUOCwoY25vZkM7QmRxTzlUU05GTSxMMmM7O2JlN1hNQj9pTG5cTUtl\nZ0U4YmtWbW9IIjBpU2NmJS5UU0YuO0YpR1AjW0UxbiNtMSlrZlRFUlAhV2EnayNXTnNjRSJFJGY4\nZkRaK2FlXCtJVVxSUUwodGcyaC4rLDpTR1FnOUZNX2EzXXE9PE9hTjVcLT45WCUjUG9ZPkhKOE5n\nNkxAUk1AYF51KiFyNlpjPTkpQSFlRS5XZVxoJkBZSUtfZWZzOj10aVdYPTplS2oxWVUjVW9hSVsu\nMzJBWilaWlxBQWtSVUY5KjRWOzFJcCNAdTUmZjRdcTVsbihPPGBbMipCWXJrInJucW5ORnAyVD9r\nPnREcVxOcixnVmE1WzQrOiZVZVtyY1E6cnFQTzA1O1okXzRUUC9qJHB0IWxWZGFEaF4tUk1YbmYm\nIXM3PkUiJV88SEkvMXU3QDQ6KUsra1ZISmExWHA8WSkzT1hpZyJPNGRLbTVePDRoXWhFMEglUmEt\nMVBsUGpEbF1ZXTlsLmVeS04kPjFyZUhRbnApXTQ/KjghJ2JnNzNoIUNvYTcmckc8Lyw2I1kzVjo0\nYS87ZlRGP1szN2FobyMoalFVNVwhJU8lKjdrVSxOPy9SP2ElM1VZYSZMQGNCZDlTLEZmIUVuLDJ1\nVGVZQCprNlQ+W0UjVSVqVlAsYzAoOTQyRF1WbmwxWVZyO3BAJk0vOlMkZCFyWzM6dUg/NHVePEM6\nK3NxJzNeMSdKMFFgTDdQOVAqSkV0UjxjKSthbzRzK1JoOVQnMzQ8JDw7aXJWLXNaZHE/KGNdajw4\nO09WKFlqTzgpLz1IXkgtSWJ1Y09VJWoxIk0rVm8uVl07TlFWcT1YRGRbQDc5SVBmLydDNHJrVV9n\nZW1JbnEiVzo+PktUM3EjbUFXQ0hocF1iXEMjcCVqVGM7PWklbVBZLykwUXNNXGkoO1UlJ11NK3Vs\nYDNgQltCTWpgV3VyJFouMEY4cC5ZXSohJ14zYC8xXGRoQFZhaU4/Vi5VZStFRC82Yi9gLzgval5R\nKylhKVVEQ1k7cS9tZnFnN242KENQP186Yz9YWSZxZSJHYTZJXCJWUVFWNiQ9bSNjMURpSFJSa0dx\nWSFcQSZqVj9EVm4yPy9uLnVPbTEkXldoK1NKc2FDbkoqO0M0MkZsNGVQWFcvbzprUShjWy5CPSgk\naWFSRGNoPkFpIU8mbEQxWlNXR190UjFcRTZrOiVXR05tKyhaXltnWSkoJ244Ul4yMFsna15kWm1O\ndXAlUjMzcFYubWVjYitLOFRZL2g3SzxuSE4xXlEpS19YT0BVWy40XnVrRUYpWGdJUlFtNHRMaFte\nX29wKXUxRF1yQSg5QjZsInQqXitoNmtXaFcscTdhKGAqY2MlMyVKP0VPJFQmLjlLUlVnVlRzSjU7\nSlxwS2lQUTBGT1gqKFYpTUo1XUJoW1VfKnBYcT5TUl47WkNqbiRCRjM7O0E2ZkYkNyFocmoxTSIk\nUltoNk8yXic+WUNudGtmaUk6JVMiTFlSWjUwKWpwM3JdKl1XKWE+JU5dUFRjcDZaV0Y5aDAjVz10\nZDY8L1pncHRRaWluWXQkSVQwJnQ7PVVCMkNXTk4hTyQ/cWwxLFZFcU1yM0NoUG9cJFMhN1cyWWtp\nakVQb0FTO1xXaGEuaCduK1BcXilSQXIxKVBDO1ZbQSsyWE9Wc2ZbQUpEajQ2JiNeViVTaVFUMVZA\nV0ooKTQ/QVlzPyspbmhUIUNrNzY0ZmorbDwscGxFPUpNPUM4KS5xaEc9T1xNNnItTCJTMFZAXkkx\nPSw4LU0jOS42bUFuS0NTSEdgakg+TWlpa0AiSmZQRWs/PCopRDRXbmZpUWdMV3VlP1U0NjItZScy\nOiY6MXQuU0lfS0orVXFqPTYrayUsLyxtJlgzZl1ORDM5XkIoNjEuKyE2NiokIzxhZ0pqKSIsTD5A\nSkpeXWRsJjxDYSpvQWFAQj5Waz02YEMqJVkpMyMuWyklJUZqaVVMSSZyXjZpbi4oLV4ocjdzMkdM\nO0Y2JjVLUT48WDo4VDNiXGthXTZFSTtOQSNQUThIZzYmNDdxRFAiYldUTissRipYP21JZW00bF1A\nUmdnLVtTY15eMUpaNnU5PSYmJTwtLSxpTl1pSUpYZTpOM3NnRjkmYGAwbUhzNWdFbW4/ZiFrY1Yp\nZGonOFNVSFtuMFUiNi09LCtoJTIpL2RwaVZlIVZdYWZfZEUpNmxfZihDS0RtVSIxUz0iKW0kMTte\nbS1MZ1RyL3I6O2ljQk80KF8pR2ZGNFdscyU0LS9POC8nZ2krVCpScmZxNidVKSxaKDtdXlYmcCta\nWmNkTCgtKkxVLWFFXy1bQFRhIiYhSlddMzw7LzgwWkZqUCUxWENzVWFCWzlMbycoZGpUYDgkSVNc\nP1knL11oMWpJSF5oVFMmIy9YMCZmTHJvPlFIIXFNPGM4YjRLJS9lb1VKW0gmMjskXl5MSVUxSm4t\nOV5yNz1dS2IwKTlXazVQRzFkPzBJfj5lbmRzdHJlYW0NCmVuZG9iag0KJSAnRjInOiBjbGFzcyBQ\nREZUeXBlMUZvbnQgDQo0IDAgb2JqDQolIEZvbnQgSGVsdmV0aWNhLUJvbGQNCjw8IC9CYXNlRm9u\ndCAvSGVsdmV0aWNhLUJvbGQNCiAvRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZw0KIC9OYW1lIC9G\nMg0KIC9TdWJ0eXBlIC9UeXBlMQ0KIC9UeXBlIC9Gb250ID4+DQplbmRvYmoNCiUgJ0YzJzogY2xh\nc3MgUERGVHlwZTFGb250IA0KNSAwIG9iag0KJSBGb250IFRpbWVzLUJvbGQNCjw8IC9CYXNlRm9u\ndCAvVGltZXMtQm9sZA0KIC9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nDQogL05hbWUgL0YzDQog\nL1N1YnR5cGUgL1R5cGUxDQogL1R5cGUgL0ZvbnQgPj4NCmVuZG9iag0KJSAnRjQnOiBjbGFzcyBQ\nREZUeXBlMUZvbnQgDQo2IDAgb2JqDQolIEZvbnQgQ291cmllcg0KPDwgL0Jhc2VGb250IC9Db3Vy\naWVyDQogL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCiAvTmFtZSAvRjQNCiAvU3VidHlwZSAv\nVHlwZTENCiAvVHlwZSAvRm9udCA+Pg0KZW5kb2JqDQolICdGb3JtWG9iLmFjZTQzZmE3ZGRhOGQ4\nZmZmNjdmOGQzMWIxNWJkNzMyJzogY2xhc3MgUERGSW1hZ2VYT2JqZWN0IA0KNyAwIG9iag0KPDwg\nL0JpdHNQZXJDb21wb25lbnQgOA0KIC9Db2xvclNwYWNlIC9EZXZpY2VSR0INCiAvRmlsdGVyIFsg\nL0FTQ0lJODVEZWNvZGUNCiAvRmxhdGVEZWNvZGUgXQ0KIC9IZWlnaHQgNDINCiAvTGVuZ3RoIDI1\nMA0KIC9TdWJ0eXBlIC9JbWFnZQ0KIC9UeXBlIC9YT2JqZWN0DQogL1dpZHRoIDQyID4+DQpzdHJl\nYW0NCkdhdWE6NW1rQ00kaj8ldXMxTT1vOFstb1pCOzwjJ1NKYytxcXRJTW0oKFsxPDYvJDlTU1Y9\nSDhUSzNSTj0kaEVBPWZrUiYpSiRTaSMmJys+bDhMdFxgKWlFLiU/YiJGIzA3P20zIU1WTFI2cmg/\naTlKMlxyME9baCVnOzdMViNfME47KlxCJyYnMWMxIUxoXlQ1aCVMR1U3KTxQMiRwTGNbL2NzXylk\nbGFmIixiVGpKNVomKGkuLStnRShpRCImLXJccG8uMD9zKFQyKyUrMER0V3JBIm9jZUpuWUAqITRZ\nMSFuQTdsZUpuWUAsRFNYRG1LJWExX1t1fj5lbmRzdHJlYW0NCmVuZG9iag0KJSAnRjUnOiBjbGFz\ncyBQREZUeXBlMUZvbnQgDQo4IDAgb2JqDQolIEZvbnQgSGVsdmV0aWNhLUJvbGRPYmxpcXVlDQo8\nPCAvQmFzZUZvbnQgL0hlbHZldGljYS1Cb2xkT2JsaXF1ZQ0KIC9FbmNvZGluZyAvV2luQW5zaUVu\nY29kaW5nDQogL05hbWUgL0Y1DQogL1N1YnR5cGUgL1R5cGUxDQogL1R5cGUgL0ZvbnQgPj4NCmVu\nZG9iag0KJSAnRjYnOiBjbGFzcyBQREZUeXBlMUZvbnQgDQo5IDAgb2JqDQolIEZvbnQgSGVsdmV0\naWNhLU9ibGlxdWUNCjw8IC9CYXNlRm9udCAvSGVsdmV0aWNhLU9ibGlxdWUNCiAvRW5jb2Rpbmcg\nL1dpbkFuc2lFbmNvZGluZw0KIC9OYW1lIC9GNg0KIC9TdWJ0eXBlIC9UeXBlMQ0KIC9UeXBlIC9G\nb250ID4+DQplbmRvYmoNCiUgJ0Zvcm1Yb2IuZWMzODA3MDc0YjRjNDhlZWEyN2JlM2YwNjk3Zjhi\nYWUnOiBjbGFzcyBQREZJbWFnZVhPYmplY3QgDQoxMCAwIG9iag0KPDwgL0JpdHNQZXJDb21wb25l\nbnQgOA0KIC9Db2xvclNwYWNlIC9EZXZpY2VSR0INCiAvRmlsdGVyIFsgL0FTQ0lJODVEZWNvZGUN\nCiAvRmxhdGVEZWNvZGUgXQ0KIC9IZWlnaHQgNQ0KIC9MZW5ndGggMTcNCiAvU3VidHlwZSAvSW1h\nZ2UNCiAvVHlwZSAvWE9iamVjdA0KIC9XaWR0aCA1ID4+DQpzdHJlYW0NCkdhcjhPVEdkZTEhKSE6\nbX4+ZW5kc3RyZWFtDQplbmRvYmoNCiUgJ1BhZ2UxJzogY2xhc3MgUERGUGFnZSANCjExIDAgb2Jq\nDQolIFBhZ2UgZGljdGlvbmFyeQ0KPDwgL0NvbnRlbnRzIDE2IDAgUg0KIC9NZWRpYUJveCBbIDAN\nCiAwDQogNjEyDQogNzkyIF0NCiAvUGFyZW50IDE1IDAgUg0KIC9SZXNvdXJjZXMgPDwgL0ZvbnQg\nMSAwIFINCiAvUHJvY1NldCBbIC9QREYNCiAvVGV4dA0KIC9JbWFnZUINCiAvSW1hZ2VDDQogL0lt\nYWdlSSBdDQogL1hPYmplY3QgPDwgL0Zvcm1Yb2IuNThkMzRmNmE4ZDVkZTc1NDNlYzQyYmRmMDFh\nMWI3YjEgMyAwIFINCiAvRm9ybVhvYi5hY2U0M2ZhN2RkYThkOGZmZjY3ZjhkMzFiMTViZDczMiA3\nIDAgUiA+PiA+Pg0KIC9Sb3RhdGUgMA0KIC9UcmFucyA8PCAgPj4NCiAvVHlwZSAvUGFnZSA+Pg0K\nZW5kb2JqDQolICdQYWdlMic6IGNsYXNzIFBERlBhZ2UgDQoxMiAwIG9iag0KJSBQYWdlIGRpY3Rp\nb25hcnkNCjw8IC9Db250ZW50cyAxNyAwIFINCiAvTWVkaWFCb3ggWyAwDQogMA0KIDYxMg0KIDc5\nMiBdDQogL1BhcmVudCAxNSAwIFINCiAvUmVzb3VyY2VzIDw8IC9Gb250IDEgMCBSDQogL1Byb2NT\nZXQgWyAvUERGDQogL1RleHQNCiAvSW1hZ2VCDQogL0ltYWdlQw0KIC9JbWFnZUkgXQ0KIC9YT2Jq\nZWN0IDw8IC9Gb3JtWG9iLmVjMzgwNzA3NGI0YzQ4ZWVhMjdiZTNmMDY5N2Y4YmFlIDEwIDAgUiA+\nPiA+Pg0KIC9Sb3RhdGUgMA0KIC9UcmFucyA8PCAgPj4NCiAvVHlwZSAvUGFnZSA+Pg0KZW5kb2Jq\nDQolICdSMTMnOiBjbGFzcyBQREZDYXRhbG9nIA0KMTMgMCBvYmoNCiUgRG9jdW1lbnQgUm9vdA0K\nPDwgL091dGxpbmVzIDE4IDAgUg0KIC9QYWdlTW9kZSAvVXNlTm9uZQ0KIC9QYWdlcyAxNSAwIFIN\nCiAvVHlwZSAvQ2F0YWxvZyA+Pg0KZW5kb2JqDQolICdSMTQnOiBjbGFzcyBQREZJbmZvIA0KMTQg\nMCBvYmoNCjw8IC9BdXRob3IgKFwoYW5vbnltb3VzXCkpDQogL0NyZWF0aW9uRGF0ZSAoRDoyMDIw\nMTExMTA5MTAwNiswNicwMCcpDQogL0NyZWF0b3IgKFwodW5zcGVjaWZpZWRcKSkNCiAvS2V5d29y\nZHMgKCkNCiAvUHJvZHVjZXIgKFJlcG9ydExhYiBQREYgTGlicmFyeSAtIHd3dy5yZXBvcnRsYWIu\nY29tKQ0KIC9TdWJqZWN0IChcKHVuc3BlY2lmaWVkXCkpDQogL1RpdGxlIChcKGFub255bW91c1wp\nKSA+Pg0KZW5kb2JqDQolICdSMTUnOiBjbGFzcyBQREZQYWdlcyANCjE1IDAgb2JqDQolIHBhZ2Ug\ndHJlZQ0KPDwgL0NvdW50IDINCiAvS2lkcyBbIDExIDAgUg0KIDEyIDAgUiBdDQogL1R5cGUgL1Bh\nZ2VzID4+DQplbmRvYmoNCiUgJ1IxNic6IGNsYXNzIFBERlN0cmVhbSANCjE2IDAgb2JqDQolIHBh\nZ2Ugc3RyZWFtDQo8PCAvRmlsdGVyIFsgL0FTQ0lJODVEZWNvZGUNCiAvRmxhdGVEZWNvZGUgXQ0K\nIC9MZW5ndGggMjU4NCA+Pg0Kc3RyZWFtDQpHYiIvKDhUV1dFJ1lccTZycklsclBZUW0+LWc3JERi\nR2RQbiZyVD5OTTBrbUBiI0twSiNwbjNyXltFRFdKSityOTo9SUZvJzI/SUwqb0AoNltzXDYqLDRM\nWV5zMlBNIz9AMW5kIlwiWSFEaTFMLyFkT210bzFpKXFRbGYmQUt1QDQnY0IxSiFtJ3I0cmJEQ2Mv\nN1JTWis7bC1CPlk6ZFwqblM6LCQ7R1hmaS5VUSE0LF1IIjcwR1xJXVIxZWY2T1lgYHE0P1BjUENP\nVlNTW2E4RFBAOTQmK2ZuIjpvSS1LRVRoPyQ5Y1lqMlI+cCpPQVIiNSFySkRTLVdscl5IUltvY1xe\nPTprLSQlTSM/P281aSRETGZqP3FWNWkqbHBFP2dJVSstRTpiJj0rX1s4T0NlIzU/amxAZy45M2JE\nNUsiXERDWTA7PmNrcCo5NkFpUUtNYj5LMG9DWyo7UTdeVzdpX0hnMDBbXGE0Olcvcy4kZyEjQD9J\nUklfK2wsZzlRUW1RSDk9Pm4sL0xMWlkmWE9MSkxPTScyUVNhZGdpYDFdMz51TV5mdExvdCRgIydx\nZ3VYT3MwU0A6JEJgKFNgXlI9M05sdWUjLC0wUW8iNEcwJyIpQEUhUV9ZSiRHS1NDIzQ6Vmg6OGVm\nZTVzKmhcRjE0cUFgSmJCanFZYCFaPDVmXk5ubzddVG8vL0Qkci9lLkVuVEItOGA6cSwuSFdOYUhg\nW2JDRlJlPFEwZDEtJ1FkZDFFbWY+YVE0WDlEQDhKbUBca0BfTktIPGIqSmwxLXFCWjFsUDUyJ0s/\nNlM3RmhNVGNKKDBYblpyZ1RzS3BbNUpWIl8lZiZsdCgnQkovaUI7akxqTVFsWSNHRWZaOXNhaDxn\nW0BeTi5DJkEhaGVNbmN0X0BxOmNBPk5eayU9ai1cb15VPDEkMz9yQms3cixFa1NlOTw1UVcqYWoz\nU0xTN1pvbytwMCopLkV1V2YlWm49PkQwRj8iLkE+T2xablRCbWlVOVY9WU4jKGgpS3RgNCY+Si8w\nIShFUTA8ZCZAJ1UoR1U+cDgvNUddNWZOOVllQlBmSlYsQnVzPWZnO3M3SFBtKV0lLCxJPCE4UzYq\nVTZeajolNTQ8VzxWP2pJIURKTl9wSEMlW29gXkRhKTtkKGxZKll0TG5iM0VCR043TF1iRyZ1RV80\nJTtlU1opNFhnLStkMzxlTkpzREA/X2M6UW4vOF1GNSknIW4sN2g8XDNdO2RqN1RVWmNzPWlsV0JX\nZj9dPVJdNCM3WXV0M1dtbUZeQTJhQkBOL1VyIyMhLk1MYjMxOWVmcUdHPHBwK1QmP004VV9bVEtb\nb1p0aVtSMU8ycD9XJ3VEJy5VKytRJFpyT1ttRCF0IjNOWCotczlDNGxNQE86KSVNIzJASFs8VkxN\najciclUsR01uV21pV0YxJG9VMnJQdWVscTVwdEZwVWglTXNFXmZcRzMoOUZEWUhtJFxrVDJIY2g1\nSFFeUCQiIWdJXVVLY19uYGEoNWdhJSpMb0MxM2AnWCQ/X0cuOXJtdDtaI0lMNVVgKT4hamVJI20u\nSFhsLk5NSGRELWxvak5jLjMoSm5CYTJkX1IiKyVnQTlLUDYzRF5fVDlJUzpBVUtFRzxjY2cmZFJJ\nYSthOTdFKDtaMyVvczZOa1pRK21TTyQwcidKR0hLRU9NblI8O0FLdV5HKicwW0hASFRnVk5oPD8m\nME8rakRJUGE/STciSDUsYGhMajc9UGE4cGw6KykvN2gpJisrLmNVRGpGOSMlMUcpUjQhN0JWbDo0\nWmchclhAL2FeQ0k6OzcrPGEoJThWM1QuYUpDRkFbS1JHY0suTycubCZUIipqMSdsYS9GNmg3QmdX\nOkdNSVNSSUsmbmIoQVs5IVxENGhycVVJTDgyW203KFtbNSo4MGRiJj0kaFlmVzlVJVUjIkR1ZCQq\nJlpcKz0sYzVsI3U4bWpFTiFBP2peVDVMLyJLRmw6UGcvakxXO24lQWFAT1syUV8hI2NPUkonJyRl\nTlVMJldVSDI4cl1yVF4vYkIndWAwRiYyInNGWzhPRSc4aVhCbmZOWXRpPUIubjBvXiFMISxuckFW\nNk0zWUEoaURBP2ElOTwuZTQqS1BMU3BxJWpgTVY2TChEYUkzPCcpJ19oW0BNQm01NGwhWGc+aTpC\nK29UKUgnZFZuQ203TE5sJysuWywvPCVCcTlnREUqRG5yW11PQGlVWCJuXV1GKmddK2RAVmhHK2km\nKzRvajglOzFQTi4qcDNzcTAwLFQhRUIyZUlMPEAwJmxtJFhYTVpOR0tERlVaMUZzMG5LWFEtXENR\nLSZtYTU1bmkxa19CI2AsVUtAam1lLUo2RDxGViglSmxFPjA/O2g1Vz0vZCMrSm4oXGVTIzgubU0v\nLSVDT2wjbEFjTFJ0XypJREA5J1xQK2lPZEA/TiE3c2JDaiFXW0s/MWU8aS5US0lcJXVmO0pQS05L\nYlVsaCJvKXJrcXBVUidQVThZajtVTTRcVklVSWlBLF9Ra0ZmW0lIXGRFRmQhY2pwS1wpQDNFVV4s\nMCdTJHE/bFBOJVIqTSJyTVdxb11OL1AnKSJBP25VNC9IW15aZEVkLG4pO0F0TiNDSlxqVVU+dUks\nbGJFKGgzajteOTsjWm4oOiRHVGRjUWxxa11FJyQ6dTY/bkJuLFBIbipPV0U/KSYqQCdeQG4sZE9V\nb28+QjpWWF89UE1JJG8sZC4waEZWZV1caGA3T25XWWpwIShvT3FeVnMtcTNhNC9OYWBEZlNVWDEl\nNWQpO19yZC8qKGAtL0tOcTdgMnE6UjQyZ0taOmE7ZCJcMGRmbip0QyMoIz5aP1xALVcqOSI5N3RE\nSiI3LEJpZHMsXDgkaSMtJiwiMydaLkVPL2FIYiNrKT1VT3VaXlxKOjxtTWxmTmlwRl9MRkElSjg5\nKj45L2tLKi1uRTk+JU5QYGhLajIwTmtyJ2s2dGEqK3VVUCldcT5wZ2wuSU5GVThtNUZGMGBMSDBn\nZWpYUzxnOy0kUnQzJC5paWInPlAxUVw5UFpdXDMiSEtROmJSUl4xLShhbVhvND1BJWxjN1ppa2s5\naCdUPEtYQjYkJkUuRjVWL0suIXJwLUApXFNnRGtAW0QrNEhRVTRgX0cjY2NZNmZPWiZtaUkkLmc1\nUURRSTpJZXJGcVFwbSd1RT9wL18lOCxRdV1nXWwkRmhaPERTZyJjTSdPaWlGUE1bVG1zU09XI2Am\nJXBxaWtpZXRANzh0P1FPKzJDcUE5UF9zVFZOVFlRWVk9UklaalcsNV9cJVZgY04xVF9KbE1oREgj\nYmhuTEtaQClfVzEqPy5TJD0/SipqY2I5UFApXz1pYF1JJk1JRGRvNEYoQFxLR2AnLVhVVWVeNkZb\nc2RtVzkvJmxDdG8mSzMsKjInOFl1MmZaRXJiPjJgNiZUaT9pMm1fRVxPVH4+ZW5kc3RyZWFtDQpl\nbmRvYmoNCiUgJ1IxNyc6IGNsYXNzIFBERlN0cmVhbSANCjE3IDAgb2JqDQolIHBhZ2Ugc3RyZWFt\nDQo8PCAvRmlsdGVyIFsgL0FTQ0lJODVEZWNvZGUNCiAvRmxhdGVEZWNvZGUgXQ0KIC9MZW5ndGgg\nMTk0NCA+Pg0Kc3RyZWFtDQpHYiEjXj5CQUxYJ1JuQSVya2svV1NSJmY/VyRQZlRxaidzRltfJDdC\nVlgzQ2YwPl1vJ10+Z1MuKlFsLlMsQkc6OiZpa1YhOUpWSGU2LjVMdWdOUjBGMzp0K2deW1ZsbnBD\nPWpNQCkrYURIR0kxWiNHIk00Z0dxSW9HJ3FnIVUkRGtHTi9zJD9uOT9KVV5pYSNqSUxybmhAJzI8\nXDtTQTo9QXQ/WW1cTVNGZG1TcjVISXNhWk1ZZjUkQ0ZHQC5STFQiQ0FSbCkvSkRwTWBVazo6WSdY\nNEk7VXJAWkBeL0J0ZGopdSJ0YydGKzM4UEtbVnFcPmZfcF03QG8vYmdMXzs9NjZaRWw6blxBQE4x\nPG0tP2x1S045N2BjWTA/XU86UzBSMmskSENBIXAzSyU+WDtaI2xoblA0ayNwRGUhKyVgRCE5VWVY\nVklrOjgjOzJvdVsncTROay1YYT1sNWI4Xl0oZ0M9T2Znb1NdbTVpTWcuRHEkKFw0VW1KKiYtITgk\nPVNBKVpEOCEvV0FONEJmZzE4bGMhMWQuIVdAXkRVL1dgRnRgMWhLUUZcNG1LSmo1JktCJD9gcF1E\nYTlcdUhVST10TzRfQD5jZV8qI15yMEpmQGQxWjUqZzc/UF80ZksuO1hiISI/R1xhUyQoalUtSzNZ\nRl88O1dvSVNlYF5TVisjZ3B1NGowVGU9VVJhOkRUYnQtOkVTSmVAbyEiRDFKdWFNclYxaG00S2pm\nUyRAMj0oJmZqTDZSVFd0cDcpUXQjcmNcSFpqRidVMigtKDFzMV0yMnNtWzopKGUlMk5JTkpwIjIr\nSkpCUm1iQ25HXmNyYCoqJGQ9VHQiZGc2X3FaP0ltU3RJIWNjX1lvOmgmQF5kZ2xzISheaCQ2ZERX\nbCMkcDcodVJDIltVXl0jZUo/bCRqQ10lZC4/RzE0ZyJGOTwlT1Y8R2ZmVm8uPydZSHUkZTQ9UGgo\nU0o/TlFebyZVSWBAS1Bfa0EhTihTOnAjYDBKJ10qVGAtdWZBTGpvS1ohdGQnNU81WD1NLUouaXFc\nQTVeb1w0KHNVTmBaIVxVLExURzdCMnFWakJaQCw+XmVxaEhURSgtMkFMTUJeb3FPI1lARVBuW1sy\nNWU2QUFnXmVTczZfWzJhVEA2MCo/TiQ6W1lFT2tyYXJQLy9BSS4uXysqVHREQmAxNjBQP2ZWZ1R0\nXys/X29FQytOZkA8KGthISM1UEY4IiNuKlxoXE84KSpxWFRVWzkqPiknOSVEN1I+alIrYzkvcj1m\nMjpjQFdETlctdD9qW3MpQjxLLipVJWBINyleT2FtSC03WktCbkYtNkNaUVJKK1lTKCRUYTssSGhq\nPVYzNidiWCZyPDRVckJZdEAsLmc5SkYsKHM2aWo5QUBYb1RgUkhJV1xCak9XV0J0Qlg0cEk5M21G\na2F1NkJRQ0MwbTg2RGhFXkcncWI8aScoNWxsInJVWEZkOjZ0PmpMWzlMRStbUGo2PXJSV3NpNUtg\nSkIzSk9mY3AiMSNMW3V1RD42OFUnJ2ljZ28pKTAlOCEiQ2RjODkjU1tUST5YQ2RYOCcsZDROR3Jy\nMT4uXHFGdW5DMGNDSVYqTCNkYGhAVWMlNStMOjRYJEs/My1pVzRgVkd0bzhWakg9ajgnU24qUE5G\nb1lDKGpFJnVYLSwiclptblgmOSQtUGRkJy10Xz89RzdMRmkoYiQtRXBLOmVpcEg1ODkzWlIvRHRI\nL1EqWkBYOEY/MThjSD0pdD5wZVV1MWo6YjU8WklOV0JaNHVFTE1oJ3FNJjsiPToiYnIxZUBpZlUv\nbm8/Qy0nITkqNEJRaSJSXTgvI1UxOF9KbEljaEs9SG8lZiluZWppIWslR0RKL1FBJiZgT0pmYXR1\nS1knKUksdWdOYjhpQ1MlSGxOUCNkI208K0lPNmQ4RkdFQ0gkNmI5a110MD0pKE4/MVBzTmEwXmZV\nNEpwcFI/W25xUGxjQGIqLSJjNElJQSdGZHEnOXUqNlc0VWpZblpoUy83ZmlJb09RNWtnSGNIbltR\nZDwvKTlVNU5sOig1cUpbaEo0OEdqQDdfRT8sPlZBTDxcL1RXY01XSm1tcyQ3WSowQT00Z29vPGZT\nTyh1ITk1VTRZUCE7SDV1Wk1CR11mPkdkZjtPYT86dEZAVCJucjZVdEIwNSl0M0EhTjc0TEkrPEQ4\nW0lhMiNsPlZ0ZnNWNFpwJlhGTGRscVlqU0VcZThII1JIRnI0UnJqTShDcTtoV3NUWUphbjkxOUst\nWSlhWCdFZHEoXm4mOj5zbSVccG5CY2gpKjI/JzNQdF84bCwmQmlVPU5kTnE6ZVJNJmwwSj4rYlg1\nUlZvOz0maChAZ2VbbjFAZWBOPSNTXj0zMSNVYzhRLTFfJyxiTUNUcWJ1KkArNTlqWGIyVkRYMixr\nRVRFaUEpLygxZVdhYGpXUklMVktRXk9PcWlTV1ghZ3FUYEosYFwvOSZEW2UjIVVeVTQrWGZkS1BD\namJaO0kncE8pVCNoWTRDSWwzZyRKbjlOQlxeLG0kKF5TUz1ca09qUStRcF5jK0QwX2lEKShRVD5e\nLEQzcyxKWCRFY0pcS11KKW5WJUR1fj5lbmRzdHJlYW0NCmVuZG9iag0KJSAnUjE4JzogY2xhc3Mg\nUERGT3V0bGluZXMgDQoxOCAwIG9iag0KPDwgL0NvdW50IDANCiAvVHlwZSAvT3V0bGluZXMgPj4N\nCmVuZG9iag0KeHJlZg0KMCAxOQ0KMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAwMTEzIDAwMDAw\nIG4NCjAwMDAwMDAyNjkgMDAwMDAgbg0KMDAwMDAwMDQ3NSAwMDAwMCBuDQowMDAwMDAyNjkzIDAw\nMDAwIG4NCjAwMDAwMDI4NjggMDAwMDAgbg0KMDAwMDAwMzAzNSAwMDAwMCBuDQowMDAwMDAzMjM3\nIDAwMDAwIG4NCjAwMDAwMDM3MjIgMDAwMDAgbg0KMDAwMDAwMzkxMSAwMDAwMCBuDQowMDAwMDA0\nMTMzIDAwMDAwIG4NCjAwMDAwMDQzODEgMDAwMDAgbg0KMDAwMDAwNDc2NiAwMDAwMCBuDQowMDAw\nMDA1MTAzIDAwMDAwIG4NCjAwMDAwMDUyNDEgMDAwMDAgbg0KMDAwMDAwNTUxMiAwMDAwMCBuDQow\nMDAwMDA1NjI5IDAwMDAwIG4NCjAwMDAwMDgzNTYgMDAwMDAgbg0KMDAwMDAxMDQ0NSAwMDAwMCBu\nDQp0cmFpbGVyDQo8PCAvSUQgDQogJSBSZXBvcnRMYWIgZ2VuZXJhdGVkIFBERiBkb2N1bWVudCAt\nLSBkaWdlc3QgKGh0dHA6Ly93d3cucmVwb3J0bGFiLmNvbSkgDQogWyh9VVwzNzZBXDAzNXdcMjQ1\nW2FcMDEyXDIwNFwyNjVcMDA1XDMzN1wyMDBcMzczKSAofVVcMzc2QVwwMzV3XDI0NVthXDAxMlwy\nMDRcMjY1XDAwNVwzMzdcMjAwXDM3MyldIA0KDQogL0luZm8gMTQgMCBSDQogL1Jvb3QgMTMgMCBS\nDQogL1NpemUgMTkgPj4NCnN0YXJ0eHJlZg0KMTA0OTcNCiUlRU9GDQo=\n”

],

“data”: [],

“messages”: [],

“success”: true

}

Step 11: Retrieve complete contact information

The endpoint get_complete_contact_information retrieves the full contact information based on contact_id. You can pass an array of strings to filter your results.

Sample request

View code
curl --location --request POST 'https:///api/v2/insured/get_complete_contact_information' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",

"filter_values": ["contact"]

}'

Sample response

View code
{

"data": {

"contact": {

"display_agency_group_info_on_dec": false,

"mfa": false,

"disallow_e2_val": false,

"background": null,

"dba": "",

"cc_email_notices": null,

"date_business_started": null,

"email_print_list": false,

"agency_number": null,

"has_sweep_account": false,

"commission_account_id": null,

"direct_application_activity_to": null,

"timezone": null,

"phones": [],

"sweep_account_id": null,

"ssn_group": null,

"id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",

"issue_payments": false,

"terminated": false,

"default_agency_id": null,

"same_as_ssn": false,

"info_for_new_payment_method": {

"cards": {

"AmericanExpress": true,

"VISA": true,

"Discover": true,

"MasterCard": true

},

"options": {

"ach": false,

"avs": true,

"cvv2": true

}

},

Step 12: Retrieve property and photos

The get_property_information_and_photos retrieves the property data. You need the property_id parameter from step 4.

Sample request

View code
curl --location --request POST 'https://client.britecorepro.com/api/v2/insured/get_property_information_and_photos' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"api_key": "",

"property_id": "64b052d7-c9ff-49d7-a52b-7804b9708785"

}'

Sample response

View code
{

"data": {

"photos": {

"insured": [

{

"caption": null,

"id": "8a473faf-3560-4ee3-a99e-fa880e219f16",

"date_added": "2019-10-01 22:01:36"

},

{

"caption": null,

"id": "c1244766-773a-48cb-8297-e0622f6ab8e8",

"date_added": "2019-10-01 22:01:36"

}

],

"carrier": [],

"preferred": {

"caption": null,

"id": "8a473faf-3560-4ee3-a99e-fa880e219f16",

"date_added": "2019-10-01 22:01:36"

}

},

"property": {

"replace_loss": null,

"property_val": null,

"date_updated": "2019-10-01 11:58:14",

"inspection_requested_date": null,

"county_specify": "",

"address_state": "LA",

"protection_class_id": null,

"hydrant_distance": 1000,

"id": "64b052d7-c9ff-49d7-a52b-7804b9708785",

"address_line2": null,

"annual_fee": 0,

"address_line1": "306 E Miller Ave",

"replacement_cost_value": null,

"copy_address": false,

"iso_pc_data": null,

"address_country": "USA",

"written_fee": 0,

"risk_data": null,

"loss_history_report_content": null,

"annual_premium": 523,

"latitude": 30.245912,

"type": null,

"replace_contents": null,

"address_accuracy": "great",

"deleted": false,

"address_county": "55dd70fe-e778-43e3-9171-ed804cf65d8b",

"written_premium": 523,

"approved_limits": null,

"flag": "white",

"fire_district_distance": 0,

"loss_history_report_number": null,

"date_added": "2019-09-26 06:59:55",

"revision_id": "3a0940db-23a5-4f23-9ad9-63c15c36cd7a",

"inspection_vendor": null,

"address_zip": "70647",

"county": {

"specifications": [],

"code": "019",

"checked": true,

"name": "Calcasieu Parish",

"id": "55dd70fe-e778-43e3-9171-ed804cf65d8b"

},

"address_city": "Iowa",

"prefill_services_data": null,

"year_built": null,

"name": "Property 1",

"gross_area": null,

"date_added_micro": 145470,

"longitude": -93.010953,

"next_inspection_date": null,

"stories": null,

"builder_ready_to_rate": false,

"replace_other": null

}

},

"messages": [],

"success": true

}

Step 13: Retrieve account history

The retrieve_account_history endpoint retrieves account payment history details for a given policy_id or policy_term_id, optionally taking in filter parameters. If the policy_id is passed, the current active term will be returned.

Sample request

View code
curl --location --request POST 'https:///api/v2/policies/retrieve_account_history' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"

}'

Sample response

View code
{

"data": {

"activePage": 1,

"maxPages": 1,

"records": [

{

"fileKey": null,

"amount": 500,

"icon": "",

"date": "10/01/2019",

"data": {

"amount": 500,

"premiumOverview": {

"debitCustomFeeProRata": 0,

"revisionWrittenFee": 0,

"debitCustomFeeFullyEarned": 0,

"revisionWrittenPremium": 523,

"revisionAnnualFee": 0,

"revisionAnnualPremium": 523,

"paymentAmount": 500,

"debitPremiumFullyBilled": 0,

"customFeesBilled": 0,

"premiumBilled": 523,

"debitSystemFee": 0,

"debitPremiumFullyEarned": 0,

"debitPremiumProRata": 523,

"payoffAmount": 23,

"debitCustomFeeFullyBilled": 0

},

"details": {

"showDelete": true,

"generatedBy": "clientsys_testagent",

"payor": "Joe Test",

"description": "Underpaid by $23.00.",

"sweepCheckNumber": null,

"paymentAmount": "500.00",

"paymentStatus": "Complete",

"nsf": false,

"policyStatus": "Active",

"nsfFee": "10.00",

"showEditAndReprint": false,

"dirty": false,

"showWaive": false,

"paymentInterface": "Check",

"paymentId": "0c4f9b7d-96ef-4862-bf34-5278b8a0359e",

"confirmationNumber": "56711569979937",

"paymentMethod": "Check 213"

}

},

"balance": "23.00",

"type": "Payment",

"id": "45f88f35-1b2d-47c7-892c-212daf885186",

"summary": "Underpaid by $23.00."

},

{

"fileKey": "f8634205-1585-496f-94cd-057774fbfaaf",

"amount": 523,

"icon": "view",

"date": "10/01/2019",

"data": {

"amount": 523,

"schedule": {

"Premium": 523,

"Installment Fee": 0,

"Custom Fees": 0

},

"details": {

"showDelete": false,

"cancelDate": "10/16/2019",

"paidInFull": false,

"billDate": "10/01/2019",

"description": "Installment Invoice",

"generatedBy": "Clientsys_test_agent",

"policyStatus": "Active",

"showEditAndReprint": true,

"dirty": false,

"showWaive": false,

"dueDate": "10/01/2019"

}

},

"balance": "523.00",

"type": "Invoice",

"id": "f6ebe73b-e32c-423f-a0cf-187eb55d7613",

"summary": "Installment Invoice"

}

]

},

"messages": [],

"success": true

}

Step 14: Retrieve invoices

The get_invoices endpoint retrieves paginated invoices list related to a policy.

Sample request

View code
curl --location --request POST '/api/v2/accounting/get_invoices' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9",

"page_number": 1,

"page_size": 50

}'

Sample response

View code
{

"data": {

"due_to_date": null,

"page_number": 1,

"bill_to_date": null,

"invoices": [

{

"fileKey": "f8634205-1585-496f-94cd-057774fbfaaf",

"amount": 523,

"icon": "view",

"date": "10/01/2019",

"data": {

"amount": 523,

"schedule": {

"Premium": 523,

"Installment Fee": 0,

"Custom Fees": 0

},

"details": {

"showDelete": false,

"cancelDate": "10/16/2019",

"paidInFull": false,

"billDate": "10/01/2019",

"description": "Installment Invoice",

"generatedBy": "client_system_agent",

"policyStatus": "Active",

"showEditAndReprint": true,

"dirty": false,

"showWaive": false,

"dueDate": "10/01/2019"

}

},

"balance": "523.00",

"type": "Invoice",

"id": "f6ebe73b-e32c-423f-a0cf-187eb55d7613",

"summary": "Installment Invoice"

}

],

"sorting_order": "asc",

"bill_from_date": null,

"total_pages": 1,

"due_from_date": null,

"page_size": 50,

"policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"

},

"messages": [],

"success": true

}

Step 15: Retrieve agent and agency information

The get_agent_and_agencies_from_contact returns the agents and agencies related to a specified contact.

Sample request

View code
curl --location --request POST '/api/v2/insured/get_agent_and_agencies_from_contact' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"

}'

Sample response

View code
{

"data": {

"agents": {

"c0e9a609-deed-4552-bea4-0d2ca1ed3543": {

"photo_id": null,

"addresses": [

{

"address_line2": "",

"address_city": "Canton",

"address_line1": "221b Baker Street",

"type_label": "",

"date_updated": "2019-09-25 15:39:32",

"address_country": "USA",

"address_county": "Hartford",

"contact_id": "c0e9a609-deed-4552-bea4-0d2ca1ed3543",

"longitude": null,

"attention": "",

"address_state": "CT",

"latitude": null,

"type": "Mailing/Billing",

"id": "36b16d2c-4737-4535-b9c0-0f64647aa18e",

"address_zip": "06019"

}

],

"phones": [],

"emails": [],

"id": "c0e9a609-deed-4552-bea4-0d2ca1ed3543",

"name": "Agent Shona"

}

},

"agencies": {

"c0e9a609-deed-4552-bea4-0d2ca1ed3543": {

"photo_id": null,

"addresses": [

{

"address_line2": "",

"address_city": "Canton",

"address_line1": "221b Baker Street",

"type_label": "",

"date_updated": "2019-09-25 15:39:32",

"address_country": "USA",

"address_county": "Hartford",

"contact_id": "c0e9a609-deed-4552-bea4-0d2ca1ed3543",

"longitude": null,

"attention": "",

"address_state": "CT",

"latitude": null,

"type": "Mailing/Billing",

"id": "36b16d2c-4737-4535-b9c0-0f64647aa18e",

"address_zip": "06019"

}

],

"phones": [],

"emails": [],

"id": "c0e9a609-deed-4552-bea4-0d2ca1ed3543",

"name": "Agent Shona"

}

}

},

"messages": [],

"success": true

}

Step 16: Retrieve primary carrier information

The get_primary_carrier endpoint returns a primary carrier’s information.

Sample request

View code
curl --location --request POST '/api/v2/insured/get_primary_carrier' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

}'

Sample response

View code
{

"data": {

"display_agency_group_info_on_dec": false,

"mfa": false,

"disallow_e2_val": false,

"background": null,

"dba": null,

"cc_email_notices": null,

"date_business_started": null,

"email_print_list": false,

"agency_number": null,

"has_sweep_account": false,

"commission_account_id": null,

"direct_application_activity_to": null,

"timezone": null,

"phones": [],

"sweep_account_id": null,

"ssn_group": null,

"id": "d689274e-0ebb-48a8-86d8-1466a92a9168",

"issue_payments": false,

"terminated": false,

"default_agency_id": "",

"same_as_ssn": false,

"cognito_username": null,

"agency_billing_enabled": false,

"notify_of_overdue_invoices": false,

"portal_code": "717738",

"photo_id": null,

"vendor_number": null,

"last_login": null,

"producer_number": null,

"issue_commission_payments": false,

"is_god": false,

"api_key": null,

"type": "organization",

"purchase_date": null,

"website": null,

"risk_id_number": null,

"notice_email_id": null,

"follow_agency_quoting_restriction": true,

"termination_reason": null,

"system_tags": null,

"agency_inactive_timestamp": null,

"agency_inactive": false,

"password_attempts": 0,

"emails": [],

"flag": "white",

"ssn": null,

"date_updated": "2019-07-16 10:02:36",

"mfa_code": null,

"drivers_license": null,

"position": null,

"active": true,

"date_added": "2019-07-16 10:02:18",

"password": null,

"fein_tax": null,

"cc_claim_email_notices": null,

"oops_email": null,

"email_notices": false,

"claim_activity_email_id": null,

"accept_electronic_comm_statement": false,

"addresses": [],

"confirmation_email": null,

"name": "Bankers Financial",

"naic_number": "",

"dob": null,

"permission_level_id": null,

"credit_score_account": null,

"issue_payments_account_id": null,

"username": null,

"terms_conditions_accepted": false,

"commission_structure": null,

"mortgagee_statement": null,

"legal_entity_type": "",

"mfa_counter": 0,

"comm_statement_email_id": null,

"default_state_id": null,

"do_not_print_when_bill_whom": false

},

"messages": [],

"success": true

}

You have successfully retrieved, updated, and displayed policy information.