curl --request PATCH \
--url https://public.api.live.turrisfi.com/v2/upstream/policies/{policyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"currentStatus": "active",
"insuredEntityName": "Example Corp",
"agencyName": "Premier Insurance Agency",
"carrierName": "National Insurance Co",
"effectiveDate": "2025-01-15T00:00:00.000Z",
"expiryDate": "2026-01-15T00:00:00.000Z",
"premiumAmountInUSD": 5000,
"aggregateCoverageInUSD": 1000000,
"coveragePerClaimInUSD": 500000,
"lineOfBusiness": "Commercial Lines",
"licenseNumber": "LIC-001",
"npn": "11223344",
"producerName": "Jon Doe",
"producerCode": "PROD-001",
"productName": "General Liability",
"productCode": "GL-100",
"filingNumber": "FIL-2025-001",
"slaNumber": "SLA-2025-001",
"externalBillingId": "BILL-2025-001",
"agencyNpn": "12345678",
"agencyFein": "12-3456789",
"agencyLicenseNumber": "ABC-123456",
"agencyLicensedStateCode": "CA",
"agentName": "John Smith",
"agentNpn": "87654321",
"agentLicenseNumber": "LIC-789012",
"agentLicensedState": "TX",
"productId": "6650a1b2c3d4e5f6a7b8c9d0",
"downstreamEntityAssociationId": "6650a1b2c3d4e5f6a7b8c9d0"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currentStatus: 'active',
insuredEntityName: 'Example Corp',
agencyName: 'Premier Insurance Agency',
carrierName: 'National Insurance Co',
effectiveDate: '2025-01-15T00:00:00.000Z',
expiryDate: '2026-01-15T00:00:00.000Z',
premiumAmountInUSD: 5000,
aggregateCoverageInUSD: 1000000,
coveragePerClaimInUSD: 500000,
lineOfBusiness: 'Commercial Lines',
licenseNumber: 'LIC-001',
npn: '11223344',
producerName: 'Jon Doe',
producerCode: 'PROD-001',
productName: 'General Liability',
productCode: 'GL-100',
filingNumber: 'FIL-2025-001',
slaNumber: 'SLA-2025-001',
externalBillingId: 'BILL-2025-001',
agencyNpn: '12345678',
agencyFein: '12-3456789',
agencyLicenseNumber: 'ABC-123456',
agencyLicensedStateCode: 'CA',
agentName: 'John Smith',
agentNpn: '87654321',
agentLicenseNumber: 'LIC-789012',
agentLicensedState: 'TX',
productId: '6650a1b2c3d4e5f6a7b8c9d0',
downstreamEntityAssociationId: '6650a1b2c3d4e5f6a7b8c9d0'
})
};
fetch('https://public.api.live.turrisfi.com/v2/upstream/policies/{policyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public.api.live.turrisfi.com/v2/upstream/policies/{policyId}"
payload = {
"currentStatus": "active",
"insuredEntityName": "Example Corp",
"agencyName": "Premier Insurance Agency",
"carrierName": "National Insurance Co",
"effectiveDate": "2025-01-15T00:00:00.000Z",
"expiryDate": "2026-01-15T00:00:00.000Z",
"premiumAmountInUSD": 5000,
"aggregateCoverageInUSD": 1000000,
"coveragePerClaimInUSD": 500000,
"lineOfBusiness": "Commercial Lines",
"licenseNumber": "LIC-001",
"npn": "11223344",
"producerName": "Jon Doe",
"producerCode": "PROD-001",
"productName": "General Liability",
"productCode": "GL-100",
"filingNumber": "FIL-2025-001",
"slaNumber": "SLA-2025-001",
"externalBillingId": "BILL-2025-001",
"agencyNpn": "12345678",
"agencyFein": "12-3456789",
"agencyLicenseNumber": "ABC-123456",
"agencyLicensedStateCode": "CA",
"agentName": "John Smith",
"agentNpn": "87654321",
"agentLicenseNumber": "LIC-789012",
"agentLicensedState": "TX",
"productId": "6650a1b2c3d4e5f6a7b8c9d0",
"downstreamEntityAssociationId": "6650a1b2c3d4e5f6a7b8c9d0"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"_id": "6650a1b2c3d4e5f6a7b8c9d0",
"upstreamEntityId": "6650a1b2c3d4e5f6a7b8c9d0",
"policyNumber": "POL-2025-001",
"currentStatus": "bound",
"riskStateCode": "CA",
"entityMatchStatus": "user confirmed",
"productMatchStatus": "unmatched",
"matchedDownstreamEntities": [
{
"downstreamEntityId": "6650a1b2c3d4e5f6a7b8c9d0",
"upstreamDownstreamAssociationId": "6650a1b2c3d4e5f6a7b8c9d1",
"matchSource": "user",
"matchConfidence": 1,
"matchedAt": "2025-01-15T10:30:00.000Z"
}
],
"transactionCount": 3,
"columnMappingId": "6650a1b2c3d4e5f6a7b8c9d0",
"entityId": "6650a1b2c3d4e5f6a7b8c9d0",
"entityModel": "UpstreamEntity",
"isDeleted": false,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:31:45.000Z",
"insuredEntityName": "Example Corp",
"agencyName": "Premier Insurance Agency",
"carrierName": "National Insurance Co",
"effectiveDate": "2025-01-15T00:00:00.000Z",
"expiryDate": "2026-01-15T00:00:00.000Z",
"premiumAmountInUSD": 5000,
"aggregateCoverageInUSD": 1000000,
"coveragePerClaimInUSD": 500000,
"lineOfBusiness": "Commercial Lines",
"licenseNumber": "LIC-001",
"npn": "11223344",
"producerName": "Jon Doe",
"producerCode": "PROD-001",
"productName": "General Liability",
"productCode": "GL-100",
"filingNumber": "FIL-2025-001",
"slaNumber": "SLA-2025-001",
"externalBillingId": "BILL-2025-001",
"agencyNpn": "12345678",
"agencyFein": "12-3456789",
"agencyLicenseNumber": "ABC-123456",
"agencyLicensedStateCode": "CA",
"agentName": "John Smith",
"agentNpn": "87654321",
"agentLicenseNumber": "LIC-789012",
"agentLicensedState": "TX",
"downstreamEntityId": "6650a1b2c3d4e5f6a7b8c9d0",
"upstreamDownstreamAssociationId": "6650a1b2c3d4e5f6a7b8c9d1",
"entityMatchConfidence": 1,
"productId": "6650a1b2c3d4e5f6a7b8c9d0",
"productMatchConfidence": 1,
"latestTransactionId": "6650a1b2c3d4e5f6a7b8c9d0",
"uploadSource": "public api"
},
"requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
"timestamp": "2025-11-12T20:49:03.293Z"
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}Update Policy
Partially update a policy by ID
curl --request PATCH \
--url https://public.api.live.turrisfi.com/v2/upstream/policies/{policyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"currentStatus": "active",
"insuredEntityName": "Example Corp",
"agencyName": "Premier Insurance Agency",
"carrierName": "National Insurance Co",
"effectiveDate": "2025-01-15T00:00:00.000Z",
"expiryDate": "2026-01-15T00:00:00.000Z",
"premiumAmountInUSD": 5000,
"aggregateCoverageInUSD": 1000000,
"coveragePerClaimInUSD": 500000,
"lineOfBusiness": "Commercial Lines",
"licenseNumber": "LIC-001",
"npn": "11223344",
"producerName": "Jon Doe",
"producerCode": "PROD-001",
"productName": "General Liability",
"productCode": "GL-100",
"filingNumber": "FIL-2025-001",
"slaNumber": "SLA-2025-001",
"externalBillingId": "BILL-2025-001",
"agencyNpn": "12345678",
"agencyFein": "12-3456789",
"agencyLicenseNumber": "ABC-123456",
"agencyLicensedStateCode": "CA",
"agentName": "John Smith",
"agentNpn": "87654321",
"agentLicenseNumber": "LIC-789012",
"agentLicensedState": "TX",
"productId": "6650a1b2c3d4e5f6a7b8c9d0",
"downstreamEntityAssociationId": "6650a1b2c3d4e5f6a7b8c9d0"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currentStatus: 'active',
insuredEntityName: 'Example Corp',
agencyName: 'Premier Insurance Agency',
carrierName: 'National Insurance Co',
effectiveDate: '2025-01-15T00:00:00.000Z',
expiryDate: '2026-01-15T00:00:00.000Z',
premiumAmountInUSD: 5000,
aggregateCoverageInUSD: 1000000,
coveragePerClaimInUSD: 500000,
lineOfBusiness: 'Commercial Lines',
licenseNumber: 'LIC-001',
npn: '11223344',
producerName: 'Jon Doe',
producerCode: 'PROD-001',
productName: 'General Liability',
productCode: 'GL-100',
filingNumber: 'FIL-2025-001',
slaNumber: 'SLA-2025-001',
externalBillingId: 'BILL-2025-001',
agencyNpn: '12345678',
agencyFein: '12-3456789',
agencyLicenseNumber: 'ABC-123456',
agencyLicensedStateCode: 'CA',
agentName: 'John Smith',
agentNpn: '87654321',
agentLicenseNumber: 'LIC-789012',
agentLicensedState: 'TX',
productId: '6650a1b2c3d4e5f6a7b8c9d0',
downstreamEntityAssociationId: '6650a1b2c3d4e5f6a7b8c9d0'
})
};
fetch('https://public.api.live.turrisfi.com/v2/upstream/policies/{policyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public.api.live.turrisfi.com/v2/upstream/policies/{policyId}"
payload = {
"currentStatus": "active",
"insuredEntityName": "Example Corp",
"agencyName": "Premier Insurance Agency",
"carrierName": "National Insurance Co",
"effectiveDate": "2025-01-15T00:00:00.000Z",
"expiryDate": "2026-01-15T00:00:00.000Z",
"premiumAmountInUSD": 5000,
"aggregateCoverageInUSD": 1000000,
"coveragePerClaimInUSD": 500000,
"lineOfBusiness": "Commercial Lines",
"licenseNumber": "LIC-001",
"npn": "11223344",
"producerName": "Jon Doe",
"producerCode": "PROD-001",
"productName": "General Liability",
"productCode": "GL-100",
"filingNumber": "FIL-2025-001",
"slaNumber": "SLA-2025-001",
"externalBillingId": "BILL-2025-001",
"agencyNpn": "12345678",
"agencyFein": "12-3456789",
"agencyLicenseNumber": "ABC-123456",
"agencyLicensedStateCode": "CA",
"agentName": "John Smith",
"agentNpn": "87654321",
"agentLicenseNumber": "LIC-789012",
"agentLicensedState": "TX",
"productId": "6650a1b2c3d4e5f6a7b8c9d0",
"downstreamEntityAssociationId": "6650a1b2c3d4e5f6a7b8c9d0"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"_id": "6650a1b2c3d4e5f6a7b8c9d0",
"upstreamEntityId": "6650a1b2c3d4e5f6a7b8c9d0",
"policyNumber": "POL-2025-001",
"currentStatus": "bound",
"riskStateCode": "CA",
"entityMatchStatus": "user confirmed",
"productMatchStatus": "unmatched",
"matchedDownstreamEntities": [
{
"downstreamEntityId": "6650a1b2c3d4e5f6a7b8c9d0",
"upstreamDownstreamAssociationId": "6650a1b2c3d4e5f6a7b8c9d1",
"matchSource": "user",
"matchConfidence": 1,
"matchedAt": "2025-01-15T10:30:00.000Z"
}
],
"transactionCount": 3,
"columnMappingId": "6650a1b2c3d4e5f6a7b8c9d0",
"entityId": "6650a1b2c3d4e5f6a7b8c9d0",
"entityModel": "UpstreamEntity",
"isDeleted": false,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:31:45.000Z",
"insuredEntityName": "Example Corp",
"agencyName": "Premier Insurance Agency",
"carrierName": "National Insurance Co",
"effectiveDate": "2025-01-15T00:00:00.000Z",
"expiryDate": "2026-01-15T00:00:00.000Z",
"premiumAmountInUSD": 5000,
"aggregateCoverageInUSD": 1000000,
"coveragePerClaimInUSD": 500000,
"lineOfBusiness": "Commercial Lines",
"licenseNumber": "LIC-001",
"npn": "11223344",
"producerName": "Jon Doe",
"producerCode": "PROD-001",
"productName": "General Liability",
"productCode": "GL-100",
"filingNumber": "FIL-2025-001",
"slaNumber": "SLA-2025-001",
"externalBillingId": "BILL-2025-001",
"agencyNpn": "12345678",
"agencyFein": "12-3456789",
"agencyLicenseNumber": "ABC-123456",
"agencyLicensedStateCode": "CA",
"agentName": "John Smith",
"agentNpn": "87654321",
"agentLicenseNumber": "LIC-789012",
"agentLicensedState": "TX",
"downstreamEntityId": "6650a1b2c3d4e5f6a7b8c9d0",
"upstreamDownstreamAssociationId": "6650a1b2c3d4e5f6a7b8c9d1",
"entityMatchConfidence": 1,
"productId": "6650a1b2c3d4e5f6a7b8c9d0",
"productMatchConfidence": 1,
"latestTransactionId": "6650a1b2c3d4e5f6a7b8c9d0",
"uploadSource": "public api"
},
"requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
"timestamp": "2025-11-12T20:49:03.293Z"
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
policyId | string | Yes | Unique identifier of the policy (MongoDB ObjectId) |
Association Fields Are Set-or-Clear
| Value | Effect |
|---|---|
| An id | Links the association and stamps the corresponding match status user confirmed |
null | Clears the association and resets the corresponding match status to unmatched |
productId and downstreamEntityAssociationId follow this rule. Omitting a field leaves the existing association untouched.Response Shape
Error Scenarios
Bad Request (400)
Returned whenpolicyId is malformed or the body fails validation.
{
"statusCode": 400,
"errorType": "validation_error",
"errorMessage": ["policyId must be a mongodb id"],
"requestId": "dev-abc123",
"timestamp": "2025-01-15T10:30:00.000Z"
}
Not Found (404)
Returned when the policy, or a suppliedproductId or downstreamEntityAssociationId, does not exist for your upstream entity.
{
"statusCode": 404,
"errorType": "not_found",
"errorMessage": ["Policy not found"],
"requestId": "dev-abc123",
"timestamp": "2025-01-15T10:30:00.000Z"
}
Unauthorized (401)
Missing or invalid authentication token. See Authentication.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the policy
"6650a1b2c3d4e5f6a7b8c9d0"
Body
Lifecycle status override
bound, active, expired, cancelled, non renewed "active"
Name of the insured party
"Example Corp"
Agency name
"Premier Insurance Agency"
Insurance carrier name
"National Insurance Co"
Policy effective date (ISO 8601)
"2025-01-15T00:00:00.000Z"
Policy expiration date (ISO 8601)
"2026-01-15T00:00:00.000Z"
Premium amount in USD
5000
Aggregate coverage limit in USD
1000000
Per-claim coverage limit in USD
500000
Line of business
"Commercial Lines"
License number
"LIC-001"
National Producer Number
"11223344"
Producing agent name
"Jon Doe"
Producer identifier code
"PROD-001"
Product name
"General Liability"
Product code
"GL-100"
Filing number
"FIL-2025-001"
SLA number
"SLA-2025-001"
External billing identifier
"BILL-2025-001"
Agency National Producer Number
"12345678"
Agency Federal Employer Identification Number
"12-3456789"
Agency state license number
"ABC-123456"
State where the agency license was issued
"CA"
Individual agent name
"John Smith"
Agent National Producer Number
"87654321"
Agent state license number
"LIC-789012"
State where the agent license was issued
"TX"
Product association. Pass an id to (re)link, or null to clear the product match.
"6650a1b2c3d4e5f6a7b8c9d0"
Agency association (downstreamEntityAssociationId from GET /downstream-entity-associations). Pass an id to (re)link, or null to clear the agency match.
"6650a1b2c3d4e5f6a7b8c9d0"
Was this page helpful?