Get policy — full detail

GET

/v1/policy/{policyId}

Returns the complete policy document. Everything needed to render a policy screen — coverage, parties, locations, documents, event history — in a single response.

Status fields:

paymentStatus — unpaid | paid | failed | refunded

termsStatus — accepted once all required program terms have been accepted; otherwise unaccepted

payNowUrl — {PAY_URL}/p/{paymentRequestId} once a payment_request is minted for this policy; null until then or when already paid

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Policy found.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/policy/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "success": true,
    "data": {
        "policyId": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
        "policyNumber": "26043HJRJTL",
        "status": "active",
        "productTypeCode": "BOP",
        "createdAt": "2026-05-01T12:00:00Z",
        "firstEffectiveDate": "2026-05-15",
        "program": {
            "id": "d81f38e5-1f74-554d-c321-6ee4d1ee63e6",
            "name": "Business Owners Policy",
            "code": "COTERIE-BOP",
            "type": "BOP",
            "slug": "coterie-bop"
        },
        "carrier": {
            "id": "b2c3d4e5-0000-0000-0000-000000000002",
            "name": "Coterie Insurance",
            "code": "coterie",
            "carrierPolicyId": "f108c254-3161-48fa-be91-bfcc5d500f61"
        },
        "term": {
            "id": "e7f8g9h0-1234-5678-90ab-cdef01234567",
            "termNumber": 1,
            "termType": "new",
            "status": "active",
            "effectiveDate": "2026-05-15",
            "expirationDate": "2027-05-15",
            "boundAt": "2026-05-01T12:00:00Z",
            "issuedAt": "2026-05-01T12:01:00Z",
            "finalizedAt": "2026-05-01T12:05:00Z",
            "cancelByDate": "2026-05-29",
            "cancelledAt": null,
            "cancellationReason": null,
            "paymentGraceDays": 14,
            "premium": 300,
            "endorsementsTotal": 0,
            "fees": 65,
            "taxes": 0,
            "total": 365,
            "currency": "USD",
            "billingFrequency": "annual",
            "paymentMethod": "credit_card",
            "renewalType": "renewable",
            "renewalFrequency": "annual"
        },
        "customer": {
            "entityId": "c1d2e3f4-0000-0000-0000-000000000001",
            "firstName": "Maria",
            "lastName": "Santos",
            "name": "Maria Santos",
            "email": "maria@coastaldesign.com",
            "phone": "+1-949-555-0100"
        },
        "seller": {
            "entityId": "s1t2u3v4-0000-0000-0000-000000000001",
            "name": "Johnny Nguyen — Coastal Brokers",
            "email": "johnny@coastalbrokers.com"
        },
        "insureds": [
            {
                "id": "i1j2k3l4-0000-0000-0000-000000000001",
                "isPrimary": true,
                "relationship": "named_insured",
                "firstName": null,
                "lastName": null,
                "entityName": "Coastal Design Studio LLC",
                "entityType": "llc",
                "email": "maria@coastaldesign.com",
                "phone": null,
                "sortOrder": 0
            },
            {
                "id": "i1j2k3l4-0000-0000-0000-000000000002",
                "isPrimary": false,
                "relationship": "additional_insured",
                "firstName": "James",
                "lastName": "Caldwell",
                "entityName": null,
                "entityType": null,
                "email": null,
                "phone": null,
                "sortOrder": 1
            }
        ],
        "locations": [
            {
                "id": "l1m2n3o4-0000-0000-0000-000000000001",
                "locationNumber": 1,
                "isPrimary": true,
                "street": "123 Pacific Coast Hwy",
                "city": "Irvine",
                "state": "CA",
                "zip": "92617",
                "country": "US",
                "locationType": "office",
                "squareFootage": 1200,
                "yearBuilt": 2005,
                "hasSprinklers": false,
                "buildingLimit": null,
                "bppLimit": 25000,
                "buildingDeductible": null,
                "bppDeductible": 500
            }
        ],
        "endorsements": [
            {
                "id": "e1f2g3h4-0000-0000-0000-000000000001",
                "endorsementKey": "hiredAndNonOwnedAutoCoverage",
                "endorsementName": "Hired & Non-Owned Auto",
                "isMandatory": false,
                "premiumChange": 0,
                "fieldValues": {},
                "sortOrder": 1
            },
            {
                "id": "e1f2g3h4-0000-0000-0000-000000000002",
                "endorsementKey": "equipmentBreakdownEndorsement",
                "endorsementName": "Equipment Breakdown",
                "isMandatory": false,
                "premiumChange": 0,
                "fieldValues": {},
                "sortOrder": 2
            }
        ],
        "coverages": [
            {
                "id": "cov1-0000-0000-0000-000000000001",
                "coverageCode": "general_liability",
                "coverageLabel": "General Liability",
                "coverageType": "base",
                "limitAmount": 1000000,
                "deductibleAmount": null
            },
            {
                "id": "cov1-0000-0000-0000-000000000002",
                "coverageCode": "bpp",
                "coverageLabel": "Business Personal Property",
                "coverageType": "base",
                "limitAmount": 25000,
                "deductibleAmount": 500
            }
        ],
        "documents": [
            {
                "id": "doc1-0000-0000-0000-000000000001",
                "documentType": "policy_jacket",
                "label": "Policy Document",
                "url": "https://api.coterieinsurance.com/documents/policy-f108c254.pdf",
                "source": "carrier_api",
                "version": 1
            },
            {
                "id": "doc1-0000-0000-0000-000000000002",
                "documentType": "cvl",
                "label": "Certificate of Liability",
                "url": "https://docs.inf.plans.com/policies/f9e8d7c6/cvl.pdf",
                "source": "rendered",
                "version": 1
            }
        ],
        "events": [
            {
                "id": "ev1-0000-0000-0000-000000000001",
                "eventType": "policy_created",
                "previousStatus": null,
                "newStatus": null,
                "triggerSource": "api",
                "reason": null,
                "createdAt": "2026-05-01T12:00:00Z"
            },
            {
                "id": "ev1-0000-0000-0000-000000000002",
                "eventType": "term_activated",
                "previousStatus": "pending",
                "newStatus": "active",
                "triggerSource": "webhook",
                "reason": null,
                "createdAt": "2026-05-01T12:05:00Z"
            },
            {
                "id": "ev1-0000-0000-0000-000000000003",
                "eventType": "payment_succeeded",
                "previousStatus": null,
                "newStatus": null,
                "triggerSource": "webhook",
                "reason": null,
                "createdAt": "2026-05-01T12:05:00Z"
            }
        ],
        "paymentStatus": "paid",
        "termsStatus": "accepted",
        "payNowUrl": null
    }
}

Modified at 2026-05-05 23:27:52

Bind quote requests

Renewal payment