{ "item": [ { "name": "health", "description": "", "item": [ { "id": "65228380-d765-4b8e-a292-cf075405976b", "name": "Check API Health", "request": { "name": "Check API Health", "description": { "content": "Simple, unauthenticated health probe. Confirms the API service is reachable and its database connection is up. No `AccessToken` is required — use this to smoke-test connectivity before authenticating.", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c924fbdc-a87b-49c3-a78c-a5896c984dd1", "name": "API is healthy. Returns a JSON array containing a single status string.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69780a4a-abd7-41a7-8e15-6ac2b23270f2", "name": "API is reachable but a downstream dependency (e.g. database) is unavailable. Returns a plain JSON string.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sendQuoteRequest", "description": "", "item": [ { "id": "6406a204-7931-47e1-a112-e8f88c15a304", "name": "Send Quote Request Email", "request": { "name": "Send Quote Request Email", "description": { "content": "Send an email notification requesting a quote for the provided email address", "type": "text/plain" }, "url": { "path": [ "sendQuoteRequest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c211e7dd-2273-4066-a0e5-4c5b2f88eb82", "name": "Quote request email sent successfully", "originalRequest": { "url": { "path": [ "sendQuoteRequest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbc616b0-6fde-4618-9759-8e5ef49b9099", "name": "Email required or send failed", "originalRequest": { "url": { "path": [ "sendQuoteRequest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "504bbe53-585b-4403-b210-f794e998c95e", "name": "Unauthorized – missing or invalid AccessToken", "originalRequest": { "url": { "path": [ "sendQuoteRequest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "authentication", "description": "", "item": [ { "id": "7c745b7d-e577-4e89-b5cb-e0bc344aa7f9", "name": "Get Authentication Token", "request": { "name": "Get Authentication Token", "description": { "content": "Request an authentication and refresh token with user credentials", "type": "text/plain" }, "url": { "path": [ "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"new_password\": \"\",\n \"refresh_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b1b2cb9e-33f2-49b5-ae27-83580d7b6036", "name": "Authentication Success", "originalRequest": { "url": { "path": [ "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"new_password\": \"\",\n \"refresh_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccessToken\": \"\",\n \"RefreshToken\": \"\",\n \"ExpiresIn\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e13387b1-1e0a-4e95-a364-648ff5662971", "name": "Authentication Error", "originalRequest": { "url": { "path": [ "authentication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"new_password\": \"\",\n \"refresh_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "password-reset", "description": "", "item": [ { "id": "9b9a0325-8e42-4297-9525-34948a25c44c", "name": "Get a password reset Token", "request": { "name": "Get a password reset Token", "description": { "content": "Request a password reset token for the provide username. The reset token will be emailed to the username/email if found.", "type": "text/plain" }, "url": { "path": [ "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "username", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e37ab549-41e7-4ea5-992d-250412a59c9e", "name": "Authentication Success", "originalRequest": { "url": { "path": [ "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "username", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b949e17-b603-4a27-bb74-f1746f48dce1", "name": "Authentication Error", "originalRequest": { "url": { "path": [ "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "username", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f6914b4-7247-4fbf-a307-5297a467c488", "name": "Reset Password with Token", "request": { "name": "Reset Password with Token", "description": { "content": "Reset the password of associated username with provided reset token. Reset token is emailed to username/email if found from GET endpoint.", "type": "text/plain" }, "url": { "path": [ "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"new_password\": \"\",\n \"reset_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4474b07e-4f22-4766-915a-eca4e2ca4b3b", "name": "Authentication Success", "originalRequest": { "url": { "path": [ "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"new_password\": \"\",\n \"reset_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e59e913-9eaa-416b-8cce-fbf76e1019db", "name": "Authentication Error", "originalRequest": { "url": { "path": [ "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"new_password\": \"\",\n \"reset_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "commodityList", "description": "", "item": [ { "id": "f700980f-7b8d-4001-a3a8-4897293d3b1a", "name": "Get commodities available in the system", "request": { "name": "Get commodities available in the system", "description": { "content": "Get the list of all available commodity types", "type": "text/plain" }, "url": { "path": [ "commodityList" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a9ea101a-428a-4d5b-8eaa-d695fd7c5c99", "name": "return list of commodities", "originalRequest": { "url": { "path": [ "commodityList" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"commodities\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f068035-0d89-4141-aad8-bd3945b2c06b", "name": "error", "originalRequest": { "url": { "path": [ "commodityList" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "quote", "description": "", "item": [ { "id": "19e0cf97-38f0-4d85-98c5-60ee6df945b3", "name": "Get A Quote", "request": { "name": "Get A Quote", "description": { "content": "Submit a full quote request with complete submission details", "type": "text/plain" }, "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"insuredInformation\": {\n \"legalName\": \"\",\n \"yearsInBusiness\": \"\",\n \"dotNumber\": \"\",\n \"ownerName\": \"\",\n \"email\": \"\",\n \"dbaName\": \"\",\n \"monthsInBusiness\": \"\",\n \"insuranceContactFirstName\": \"\",\n \"insuranceContactLastName\": \"\",\n \"insuranceContactPhone\": \"\",\n \"insuranceContactEmail\": \"\"\n },\n \"mailingAddress\": {\n \"mailingStreet\": \"\",\n \"mailingCity\": \"\",\n \"mailingState\": \"\",\n \"mailingZip\": \"\",\n \"mailingCounty\": \"\",\n \"mailingCountry\": \"\"\n },\n \"garageAddress\": {\n \"garageStreet\": \"mailingAddress.mailingStreet\",\n \"garageCity\": \"mailingAddress.mailingCity\",\n \"garageState\": \"mailingAddress.mailingState\",\n \"garageZip\": \"mailingAddress.mailingZip\",\n \"garageCounty\": \"mailingAddress.mailingCounty\",\n \"garageCountry\": \"mailingAddress.mailingCountry\"\n },\n \"coverage\": {\n \"requestAl\": \"Y\",\n \"optAlPip\": \"N\",\n \"optAlUm\": \"N\",\n \"requestApd\": \"Y\",\n \"requestMtc\": \"Y\",\n \"requestTgl\": \"N\",\n \"requestNtl\": \"N\",\n \"brokerFeeAL\": \"\",\n \"brokerFeeAPD\": \"\",\n \"brokerFeeMTC\": \"\",\n \"brokerFeeTGL\": \"\",\n \"brokerFeeNTL\": \"\",\n \"effectiveDate\": \"\"\n },\n \"retailAgent\": {\n \"AgencyName\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\",\n \"Street\": \"mailingAddress.mailingStreet\",\n \"City\": \"mailingAddress.mailingCity\",\n \"State\": \"mailingAddress.mailingState\",\n \"Zip\": \"mailingAddress.mailingZip\"\n },\n \"limits\": {\n \"nbrOfTrucks\": \"\",\n \"valueOfTrucks\": \"\",\n \"trailerInterchange\": \"N\",\n \"trailerInterchangeLimit\": 65000,\n \"limitTowingStorage\": 5000,\n \"nbrOfTrailers\": \"\",\n \"valueOfTrailers\": \"\",\n \"limitAutoLiability\": \"\"\n },\n \"operations\": {\n \"opsLocal\": \"Y\",\n \"opsIntermediate\": \"Y\",\n \"opsLongHaul\": \"N\",\n \"opsIntermodalPort\": \"Y\",\n \"opsDumpTruckOther\": \"Y\",\n \"opsDumpTruckSandGravel\": \"N\",\n \"opsEndDumper\": \"N\",\n \"opsLogging\": \"N\",\n \"opsRefrigirated\": \"Y\",\n \"opsHotShot\": \"Y\",\n \"opsOversizedOvernight\": \"Y\",\n \"opsAutomobileHauler\": \"N\",\n \"opsHouseholdGoods\": \"N\",\n \"opsTanker\": \"Y\",\n \"ineligibleOperations\": \"N\",\n \"filingsAlFederal\": \"N\",\n \"filingsAlState\": \"N\",\n \"priorInsuranceCancelledNonrenewed\": \"Y\"\n },\n \"shippingAddress\": {\n \"shippingStreet\": \"\",\n \"shippingCity\": \"\",\n \"shippingState\": \"\",\n \"shippingZip\": \"\",\n \"shippingCounty\": \"\",\n \"shippingCountry\": \"\"\n },\n \"radius\": {\n \"radius0_50\": \"\",\n \"radius51_200\": \"\",\n \"radius201_500\": \"\",\n \"radius501\": \"\"\n },\n \"commoditiesRefrigeration\": \"N\",\n \"commodities\": [\n {\n \"commodityKey\": \"clothing\",\n \"commodityPercentage\": \"\"\n },\n {\n \"commodityKey\": \"seafood_fresh\",\n \"commodityPercentage\": \"\"\n }\n ],\n \"terminals\": [\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n },\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n }\n ],\n \"vehicles\": [\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"8\",\n \"bodyTypeKey\": \"tractor\"\n },\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"6\",\n \"bodyTypeKey\": \"tractor\"\n }\n ],\n \"trailers\": [\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"double_trailers\"\n },\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"auto_hauler_trailers\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n }\n ],\n \"losses\": {\n \"1\": {\n \"lossConfirmed\": \"Y\",\n \"lossAlCount\": \"\",\n \"lossAlPaid\": \"\",\n \"lossApdCount\": \"\",\n \"lossApdPaid\": \"\",\n \"lossMtcCount\": \"\",\n \"lossMtcPaid\": \"\",\n \"lossTglCount\": \"\",\n \"lossTglPaid\": \"\",\n \"lossNtlCount\": \"\",\n \"lossNtlPaid\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6ae9a077-9881-4492-9bfb-1d91ceb561bc", "name": "quote success", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"insuredInformation\": {\n \"legalName\": \"\",\n \"yearsInBusiness\": \"\",\n \"dotNumber\": \"\",\n \"ownerName\": \"\",\n \"email\": \"\",\n \"dbaName\": \"\",\n \"monthsInBusiness\": \"\",\n \"insuranceContactFirstName\": \"\",\n \"insuranceContactLastName\": \"\",\n \"insuranceContactPhone\": \"\",\n \"insuranceContactEmail\": \"\"\n },\n \"mailingAddress\": {\n \"mailingStreet\": \"\",\n \"mailingCity\": \"\",\n \"mailingState\": \"\",\n \"mailingZip\": \"\",\n \"mailingCounty\": \"\",\n \"mailingCountry\": \"\"\n },\n \"garageAddress\": {\n \"garageStreet\": \"mailingAddress.mailingStreet\",\n \"garageCity\": \"mailingAddress.mailingCity\",\n \"garageState\": \"mailingAddress.mailingState\",\n \"garageZip\": \"mailingAddress.mailingZip\",\n \"garageCounty\": \"mailingAddress.mailingCounty\",\n \"garageCountry\": \"mailingAddress.mailingCountry\"\n },\n \"coverage\": {\n \"requestAl\": \"Y\",\n \"optAlPip\": \"N\",\n \"optAlUm\": \"N\",\n \"requestApd\": \"Y\",\n \"requestMtc\": \"Y\",\n \"requestTgl\": \"N\",\n \"requestNtl\": \"N\",\n \"brokerFeeAL\": \"\",\n \"brokerFeeAPD\": \"\",\n \"brokerFeeMTC\": \"\",\n \"brokerFeeTGL\": \"\",\n \"brokerFeeNTL\": \"\",\n \"effectiveDate\": \"\"\n },\n \"retailAgent\": {\n \"AgencyName\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\",\n \"Street\": \"mailingAddress.mailingStreet\",\n \"City\": \"mailingAddress.mailingCity\",\n \"State\": \"mailingAddress.mailingState\",\n \"Zip\": \"mailingAddress.mailingZip\"\n },\n \"limits\": {\n \"nbrOfTrucks\": \"\",\n \"valueOfTrucks\": \"\",\n \"trailerInterchange\": \"N\",\n \"trailerInterchangeLimit\": 65000,\n \"limitTowingStorage\": 5000,\n \"nbrOfTrailers\": \"\",\n \"valueOfTrailers\": \"\",\n \"limitAutoLiability\": \"\"\n },\n \"operations\": {\n \"opsLocal\": \"Y\",\n \"opsIntermediate\": \"Y\",\n \"opsLongHaul\": \"N\",\n \"opsIntermodalPort\": \"Y\",\n \"opsDumpTruckOther\": \"Y\",\n \"opsDumpTruckSandGravel\": \"N\",\n \"opsEndDumper\": \"N\",\n \"opsLogging\": \"N\",\n \"opsRefrigirated\": \"Y\",\n \"opsHotShot\": \"Y\",\n \"opsOversizedOvernight\": \"Y\",\n \"opsAutomobileHauler\": \"N\",\n \"opsHouseholdGoods\": \"N\",\n \"opsTanker\": \"Y\",\n \"ineligibleOperations\": \"N\",\n \"filingsAlFederal\": \"N\",\n \"filingsAlState\": \"N\",\n \"priorInsuranceCancelledNonrenewed\": \"Y\"\n },\n \"shippingAddress\": {\n \"shippingStreet\": \"\",\n \"shippingCity\": \"\",\n \"shippingState\": \"\",\n \"shippingZip\": \"\",\n \"shippingCounty\": \"\",\n \"shippingCountry\": \"\"\n },\n \"radius\": {\n \"radius0_50\": \"\",\n \"radius51_200\": \"\",\n \"radius201_500\": \"\",\n \"radius501\": \"\"\n },\n \"commoditiesRefrigeration\": \"N\",\n \"commodities\": [\n {\n \"commodityKey\": \"clothing\",\n \"commodityPercentage\": \"\"\n },\n {\n \"commodityKey\": \"seafood_fresh\",\n \"commodityPercentage\": \"\"\n }\n ],\n \"terminals\": [\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n },\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n }\n ],\n \"vehicles\": [\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"8\",\n \"bodyTypeKey\": \"tractor\"\n },\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"6\",\n \"bodyTypeKey\": \"tractor\"\n }\n ],\n \"trailers\": [\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"double_trailers\"\n },\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"auto_hauler_trailers\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n }\n ],\n \"losses\": {\n \"1\": {\n \"lossConfirmed\": \"Y\",\n \"lossAlCount\": \"\",\n \"lossAlPaid\": \"\",\n \"lossApdCount\": \"\",\n \"lossApdPaid\": \"\",\n \"lossMtcCount\": \"\",\n \"lossMtcPaid\": \"\",\n \"lossTglCount\": \"\",\n \"lossTglPaid\": \"\",\n \"lossNtlCount\": \"\",\n \"lossNtlPaid\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"submission_number\": \"\",\n \"coverages\": [\n {\n \"al\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"apd\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"mtc\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"tgl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"ntl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ]\n },\n {\n \"al\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"apd\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"mtc\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"tgl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"ntl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1affb24e-5a6d-4733-bd03-92c56efac449", "name": "error", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"insuredInformation\": {\n \"legalName\": \"\",\n \"yearsInBusiness\": \"\",\n \"dotNumber\": \"\",\n \"ownerName\": \"\",\n \"email\": \"\",\n \"dbaName\": \"\",\n \"monthsInBusiness\": \"\",\n \"insuranceContactFirstName\": \"\",\n \"insuranceContactLastName\": \"\",\n \"insuranceContactPhone\": \"\",\n \"insuranceContactEmail\": \"\"\n },\n \"mailingAddress\": {\n \"mailingStreet\": \"\",\n \"mailingCity\": \"\",\n \"mailingState\": \"\",\n \"mailingZip\": \"\",\n \"mailingCounty\": \"\",\n \"mailingCountry\": \"\"\n },\n \"garageAddress\": {\n \"garageStreet\": \"mailingAddress.mailingStreet\",\n \"garageCity\": \"mailingAddress.mailingCity\",\n \"garageState\": \"mailingAddress.mailingState\",\n \"garageZip\": \"mailingAddress.mailingZip\",\n \"garageCounty\": \"mailingAddress.mailingCounty\",\n \"garageCountry\": \"mailingAddress.mailingCountry\"\n },\n \"coverage\": {\n \"requestAl\": \"Y\",\n \"optAlPip\": \"N\",\n \"optAlUm\": \"N\",\n \"requestApd\": \"Y\",\n \"requestMtc\": \"Y\",\n \"requestTgl\": \"N\",\n \"requestNtl\": \"N\",\n \"brokerFeeAL\": \"\",\n \"brokerFeeAPD\": \"\",\n \"brokerFeeMTC\": \"\",\n \"brokerFeeTGL\": \"\",\n \"brokerFeeNTL\": \"\",\n \"effectiveDate\": \"\"\n },\n \"retailAgent\": {\n \"AgencyName\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\",\n \"Street\": \"mailingAddress.mailingStreet\",\n \"City\": \"mailingAddress.mailingCity\",\n \"State\": \"mailingAddress.mailingState\",\n \"Zip\": \"mailingAddress.mailingZip\"\n },\n \"limits\": {\n \"nbrOfTrucks\": \"\",\n \"valueOfTrucks\": \"\",\n \"trailerInterchange\": \"N\",\n \"trailerInterchangeLimit\": 65000,\n \"limitTowingStorage\": 5000,\n \"nbrOfTrailers\": \"\",\n \"valueOfTrailers\": \"\",\n \"limitAutoLiability\": \"\"\n },\n \"operations\": {\n \"opsLocal\": \"Y\",\n \"opsIntermediate\": \"Y\",\n \"opsLongHaul\": \"N\",\n \"opsIntermodalPort\": \"Y\",\n \"opsDumpTruckOther\": \"Y\",\n \"opsDumpTruckSandGravel\": \"N\",\n \"opsEndDumper\": \"N\",\n \"opsLogging\": \"N\",\n \"opsRefrigirated\": \"Y\",\n \"opsHotShot\": \"Y\",\n \"opsOversizedOvernight\": \"Y\",\n \"opsAutomobileHauler\": \"N\",\n \"opsHouseholdGoods\": \"N\",\n \"opsTanker\": \"Y\",\n \"ineligibleOperations\": \"N\",\n \"filingsAlFederal\": \"N\",\n \"filingsAlState\": \"N\",\n \"priorInsuranceCancelledNonrenewed\": \"Y\"\n },\n \"shippingAddress\": {\n \"shippingStreet\": \"\",\n \"shippingCity\": \"\",\n \"shippingState\": \"\",\n \"shippingZip\": \"\",\n \"shippingCounty\": \"\",\n \"shippingCountry\": \"\"\n },\n \"radius\": {\n \"radius0_50\": \"\",\n \"radius51_200\": \"\",\n \"radius201_500\": \"\",\n \"radius501\": \"\"\n },\n \"commoditiesRefrigeration\": \"N\",\n \"commodities\": [\n {\n \"commodityKey\": \"clothing\",\n \"commodityPercentage\": \"\"\n },\n {\n \"commodityKey\": \"seafood_fresh\",\n \"commodityPercentage\": \"\"\n }\n ],\n \"terminals\": [\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n },\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n }\n ],\n \"vehicles\": [\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"8\",\n \"bodyTypeKey\": \"tractor\"\n },\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"6\",\n \"bodyTypeKey\": \"tractor\"\n }\n ],\n \"trailers\": [\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"double_trailers\"\n },\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"auto_hauler_trailers\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n }\n ],\n \"losses\": {\n \"1\": {\n \"lossConfirmed\": \"Y\",\n \"lossAlCount\": \"\",\n \"lossAlPaid\": \"\",\n \"lossApdCount\": \"\",\n \"lossApdPaid\": \"\",\n \"lossMtcCount\": \"\",\n \"lossMtcPaid\": \"\",\n \"lossTglCount\": \"\",\n \"lossTglPaid\": \"\",\n \"lossNtlCount\": \"\",\n \"lossNtlPaid\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "indication", "description": "", "item": [ { "id": "f3d20b55-0ff8-459f-8af5-ffeadc31db39", "name": "Get An Indication", "request": { "name": "Get An Indication", "description": { "content": "Submit an indication request with basic submission details to get preliminary pricing", "type": "text/plain" }, "url": { "path": [ "indication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"insuredInformation\": {\n \"dotNumber\": \"\",\n \"ownerName\": \"\",\n \"email\": \"\",\n \"legalName\": \"\",\n \"dbaName\": \"\",\n \"yearsInBusiness\": \"\",\n \"monthsInBusiness\": \"\",\n \"insuranceContactFirstName\": \"\",\n \"insuranceContactLastName\": \"\",\n \"insuranceContactPhone\": \"\",\n \"insuranceContactEmail\": \"\"\n },\n \"mailingAddress\": {\n \"mailingStreet\": \"\",\n \"mailingCity\": \"\",\n \"mailingState\": \"\",\n \"mailingZip\": \"\",\n \"mailingCounty\": \"\",\n \"mailingCountry\": \"\"\n },\n \"garageAddress\": {\n \"garageState\": \"mailingAddress.mailingState\",\n \"garageZip\": \"mailingAddress.mailingZip\",\n \"garageStreet\": \"mailingAddress.mailingStreet\",\n \"garageCity\": \"mailingAddress.mailingCity\",\n \"garageCounty\": \"mailingAddress.mailingCounty\",\n \"garageCountry\": \"mailingAddress.mailingCountry\"\n },\n \"coverage\": {\n \"requestAl\": \"Y\",\n \"optAlPip\": \"N\",\n \"optAlUm\": \"N\",\n \"requestApd\": \"Y\",\n \"requestMtc\": \"Y\",\n \"requestTgl\": \"N\",\n \"requestNtl\": \"N\",\n \"brokerFeeAL\": \"\",\n \"brokerFeeAPD\": \"\",\n \"brokerFeeMTC\": \"\",\n \"brokerFeeTGL\": \"\",\n \"brokerFeeNTL\": \"\",\n \"effectiveDate\": \"\"\n },\n \"retailAgent\": {\n \"AgencyName\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\",\n \"Street\": \"mailingAddress.mailingStreet\",\n \"City\": \"mailingAddress.mailingCity\",\n \"State\": \"mailingAddress.mailingState\",\n \"Zip\": \"mailingAddress.mailingZip\"\n },\n \"limits\": {\n \"trailerInterchange\": \"Y\",\n \"trailerInterchangeLimit\": 25000,\n \"limitTowingStorage\": 2500,\n \"nbrOfTrucks\": \"\",\n \"valueOfTrucks\": \"\",\n \"nbrOfTrailers\": \"\",\n \"valueOfTrailers\": \"\",\n \"limitAutoLiability\": \"\"\n },\n \"operations\": {\n \"opsLocal\": \"Y\",\n \"opsIntermediate\": \"N\",\n \"opsLongHaul\": \"N\",\n \"opsIntermodalPort\": \"N\",\n \"opsDumpTruckOther\": \"N\",\n \"opsDumpTruckSandGravel\": \"N\",\n \"opsEndDumper\": \"Y\",\n \"opsLogging\": \"Y\",\n \"opsRefrigirated\": \"Y\",\n \"opsHotShot\": \"N\",\n \"opsOversizedOvernight\": \"Y\",\n \"opsAutomobileHauler\": \"N\",\n \"opsHouseholdGoods\": \"N\",\n \"opsTanker\": \"Y\",\n \"ineligibleOperations\": \"Y\",\n \"filingsAlFederal\": \"Y\",\n \"filingsAlState\": \"Y\",\n \"priorInsuranceCancelledNonrenewed\": \"Y\"\n },\n \"shippingAddress\": {\n \"shippingStreet\": \"\",\n \"shippingCity\": \"\",\n \"shippingState\": \"\",\n \"shippingZip\": \"\",\n \"shippingCounty\": \"\",\n \"shippingCountry\": \"\"\n },\n \"radius\": {\n \"radius0_50\": \"\",\n \"radius51_200\": \"\",\n \"radius201_500\": \"\",\n \"radius501\": \"\"\n },\n \"commoditiesRefrigeration\": \"N\",\n \"commodities\": [\n {\n \"commodityKey\": \"cigarettes_and_cigars\",\n \"commodityPercentage\": \"\"\n },\n {\n \"commodityKey\": \"alcoholic_beverages\",\n \"commodityPercentage\": \"\"\n }\n ],\n \"terminals\": [\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n },\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n }\n ],\n \"vehicles\": [\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"5\",\n \"bodyTypeKey\": \"tractor\"\n },\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"3\",\n \"bodyTypeKey\": \"tractor\"\n }\n ],\n \"trailers\": [\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"refrigeration_trailer\"\n },\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"curtain_van_trailer\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n }\n ],\n \"losses\": {\n \"1\": {\n \"lossConfirmed\": \"Y\",\n \"lossAlCount\": \"\",\n \"lossAlPaid\": \"\",\n \"lossApdCount\": \"\",\n \"lossApdPaid\": \"\",\n \"lossMtcCount\": \"\",\n \"lossMtcPaid\": \"\",\n \"lossTglCount\": \"\",\n \"lossTglPaid\": \"\",\n \"lossNtlCount\": \"\",\n \"lossNtlPaid\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2261fb74-4dda-45e6-bd2b-677c4699cd85", "name": "indication success", "originalRequest": { "url": { "path": [ "indication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"insuredInformation\": {\n \"dotNumber\": \"\",\n \"ownerName\": \"\",\n \"email\": \"\",\n \"legalName\": \"\",\n \"dbaName\": \"\",\n \"yearsInBusiness\": \"\",\n \"monthsInBusiness\": \"\",\n \"insuranceContactFirstName\": \"\",\n \"insuranceContactLastName\": \"\",\n \"insuranceContactPhone\": \"\",\n \"insuranceContactEmail\": \"\"\n },\n \"mailingAddress\": {\n \"mailingStreet\": \"\",\n \"mailingCity\": \"\",\n \"mailingState\": \"\",\n \"mailingZip\": \"\",\n \"mailingCounty\": \"\",\n \"mailingCountry\": \"\"\n },\n \"garageAddress\": {\n \"garageState\": \"mailingAddress.mailingState\",\n \"garageZip\": \"mailingAddress.mailingZip\",\n \"garageStreet\": \"mailingAddress.mailingStreet\",\n \"garageCity\": \"mailingAddress.mailingCity\",\n \"garageCounty\": \"mailingAddress.mailingCounty\",\n \"garageCountry\": \"mailingAddress.mailingCountry\"\n },\n \"coverage\": {\n \"requestAl\": \"Y\",\n \"optAlPip\": \"N\",\n \"optAlUm\": \"N\",\n \"requestApd\": \"Y\",\n \"requestMtc\": \"Y\",\n \"requestTgl\": \"N\",\n \"requestNtl\": \"N\",\n \"brokerFeeAL\": \"\",\n \"brokerFeeAPD\": \"\",\n \"brokerFeeMTC\": \"\",\n \"brokerFeeTGL\": \"\",\n \"brokerFeeNTL\": \"\",\n \"effectiveDate\": \"\"\n },\n \"retailAgent\": {\n \"AgencyName\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\",\n \"Street\": \"mailingAddress.mailingStreet\",\n \"City\": \"mailingAddress.mailingCity\",\n \"State\": \"mailingAddress.mailingState\",\n \"Zip\": \"mailingAddress.mailingZip\"\n },\n \"limits\": {\n \"trailerInterchange\": \"Y\",\n \"trailerInterchangeLimit\": 25000,\n \"limitTowingStorage\": 2500,\n \"nbrOfTrucks\": \"\",\n \"valueOfTrucks\": \"\",\n \"nbrOfTrailers\": \"\",\n \"valueOfTrailers\": \"\",\n \"limitAutoLiability\": \"\"\n },\n \"operations\": {\n \"opsLocal\": \"Y\",\n \"opsIntermediate\": \"N\",\n \"opsLongHaul\": \"N\",\n \"opsIntermodalPort\": \"N\",\n \"opsDumpTruckOther\": \"N\",\n \"opsDumpTruckSandGravel\": \"N\",\n \"opsEndDumper\": \"Y\",\n \"opsLogging\": \"Y\",\n \"opsRefrigirated\": \"Y\",\n \"opsHotShot\": \"N\",\n \"opsOversizedOvernight\": \"Y\",\n \"opsAutomobileHauler\": \"N\",\n \"opsHouseholdGoods\": \"N\",\n \"opsTanker\": \"Y\",\n \"ineligibleOperations\": \"Y\",\n \"filingsAlFederal\": \"Y\",\n \"filingsAlState\": \"Y\",\n \"priorInsuranceCancelledNonrenewed\": \"Y\"\n },\n \"shippingAddress\": {\n \"shippingStreet\": \"\",\n \"shippingCity\": \"\",\n \"shippingState\": \"\",\n \"shippingZip\": \"\",\n \"shippingCounty\": \"\",\n \"shippingCountry\": \"\"\n },\n \"radius\": {\n \"radius0_50\": \"\",\n \"radius51_200\": \"\",\n \"radius201_500\": \"\",\n \"radius501\": \"\"\n },\n \"commoditiesRefrigeration\": \"N\",\n \"commodities\": [\n {\n \"commodityKey\": \"cigarettes_and_cigars\",\n \"commodityPercentage\": \"\"\n },\n {\n \"commodityKey\": \"alcoholic_beverages\",\n \"commodityPercentage\": \"\"\n }\n ],\n \"terminals\": [\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n },\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n }\n ],\n \"vehicles\": [\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"5\",\n \"bodyTypeKey\": \"tractor\"\n },\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"3\",\n \"bodyTypeKey\": \"tractor\"\n }\n ],\n \"trailers\": [\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"refrigeration_trailer\"\n },\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"curtain_van_trailer\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n }\n ],\n \"losses\": {\n \"1\": {\n \"lossConfirmed\": \"Y\",\n \"lossAlCount\": \"\",\n \"lossAlPaid\": \"\",\n \"lossApdCount\": \"\",\n \"lossApdPaid\": \"\",\n \"lossMtcCount\": \"\",\n \"lossMtcPaid\": \"\",\n \"lossTglCount\": \"\",\n \"lossTglPaid\": \"\",\n \"lossNtlCount\": \"\",\n \"lossNtlPaid\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"coverages\": [\n {\n \"al\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"apd\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"mtc\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"tgl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"ntl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ]\n },\n {\n \"al\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"apd\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"mtc\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"tgl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ],\n \"ntl\": [\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n },\n {\n \"totalCost\": \"\",\n \"premium\": \"\",\n \"limit\": \"\",\n \"deductible\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76d7d8f0-55d8-4e63-be5e-ad4ccfd3f462", "name": "error", "originalRequest": { "url": { "path": [ "indication" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"insuredInformation\": {\n \"dotNumber\": \"\",\n \"ownerName\": \"\",\n \"email\": \"\",\n \"legalName\": \"\",\n \"dbaName\": \"\",\n \"yearsInBusiness\": \"\",\n \"monthsInBusiness\": \"\",\n \"insuranceContactFirstName\": \"\",\n \"insuranceContactLastName\": \"\",\n \"insuranceContactPhone\": \"\",\n \"insuranceContactEmail\": \"\"\n },\n \"mailingAddress\": {\n \"mailingStreet\": \"\",\n \"mailingCity\": \"\",\n \"mailingState\": \"\",\n \"mailingZip\": \"\",\n \"mailingCounty\": \"\",\n \"mailingCountry\": \"\"\n },\n \"garageAddress\": {\n \"garageState\": \"mailingAddress.mailingState\",\n \"garageZip\": \"mailingAddress.mailingZip\",\n \"garageStreet\": \"mailingAddress.mailingStreet\",\n \"garageCity\": \"mailingAddress.mailingCity\",\n \"garageCounty\": \"mailingAddress.mailingCounty\",\n \"garageCountry\": \"mailingAddress.mailingCountry\"\n },\n \"coverage\": {\n \"requestAl\": \"Y\",\n \"optAlPip\": \"N\",\n \"optAlUm\": \"N\",\n \"requestApd\": \"Y\",\n \"requestMtc\": \"Y\",\n \"requestTgl\": \"N\",\n \"requestNtl\": \"N\",\n \"brokerFeeAL\": \"\",\n \"brokerFeeAPD\": \"\",\n \"brokerFeeMTC\": \"\",\n \"brokerFeeTGL\": \"\",\n \"brokerFeeNTL\": \"\",\n \"effectiveDate\": \"\"\n },\n \"retailAgent\": {\n \"AgencyName\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\",\n \"Street\": \"mailingAddress.mailingStreet\",\n \"City\": \"mailingAddress.mailingCity\",\n \"State\": \"mailingAddress.mailingState\",\n \"Zip\": \"mailingAddress.mailingZip\"\n },\n \"limits\": {\n \"trailerInterchange\": \"Y\",\n \"trailerInterchangeLimit\": 25000,\n \"limitTowingStorage\": 2500,\n \"nbrOfTrucks\": \"\",\n \"valueOfTrucks\": \"\",\n \"nbrOfTrailers\": \"\",\n \"valueOfTrailers\": \"\",\n \"limitAutoLiability\": \"\"\n },\n \"operations\": {\n \"opsLocal\": \"Y\",\n \"opsIntermediate\": \"N\",\n \"opsLongHaul\": \"N\",\n \"opsIntermodalPort\": \"N\",\n \"opsDumpTruckOther\": \"N\",\n \"opsDumpTruckSandGravel\": \"N\",\n \"opsEndDumper\": \"Y\",\n \"opsLogging\": \"Y\",\n \"opsRefrigirated\": \"Y\",\n \"opsHotShot\": \"N\",\n \"opsOversizedOvernight\": \"Y\",\n \"opsAutomobileHauler\": \"N\",\n \"opsHouseholdGoods\": \"N\",\n \"opsTanker\": \"Y\",\n \"ineligibleOperations\": \"Y\",\n \"filingsAlFederal\": \"Y\",\n \"filingsAlState\": \"Y\",\n \"priorInsuranceCancelledNonrenewed\": \"Y\"\n },\n \"shippingAddress\": {\n \"shippingStreet\": \"\",\n \"shippingCity\": \"\",\n \"shippingState\": \"\",\n \"shippingZip\": \"\",\n \"shippingCounty\": \"\",\n \"shippingCountry\": \"\"\n },\n \"radius\": {\n \"radius0_50\": \"\",\n \"radius51_200\": \"\",\n \"radius201_500\": \"\",\n \"radius501\": \"\"\n },\n \"commoditiesRefrigeration\": \"N\",\n \"commodities\": [\n {\n \"commodityKey\": \"cigarettes_and_cigars\",\n \"commodityPercentage\": \"\"\n },\n {\n \"commodityKey\": \"alcoholic_beverages\",\n \"commodityPercentage\": \"\"\n }\n ],\n \"terminals\": [\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n },\n {\n \"terminalStreet\": \"\",\n \"terminalCity\": \"\",\n \"terminalState\": \"\",\n \"terminalZip\": \"\",\n \"terminalCounty\": \"\"\n }\n ],\n \"vehicles\": [\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"5\",\n \"bodyTypeKey\": \"tractor\"\n },\n {\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"classKey\": \"3\",\n \"bodyTypeKey\": \"tractor\"\n }\n ],\n \"trailers\": [\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"refrigeration_trailer\"\n },\n {\n \"vin\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"bodyTypeKey\": \"curtain_van_trailer\"\n }\n ],\n \"drivers\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"licenseState\": \"\",\n \"licenseNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"dateOfHire\": \"\",\n \"yearsExperience\": \"\",\n \"accidents_total\": \"\",\n \"violations_total\": \"\",\n \"suspensions_total\": \"\",\n \"eligibility\": \"Excluded\",\n \"isOwner\": \"\"\n }\n ],\n \"losses\": {\n \"1\": {\n \"lossConfirmed\": \"Y\",\n \"lossAlCount\": \"\",\n \"lossAlPaid\": \"\",\n \"lossApdCount\": \"\",\n \"lossApdPaid\": \"\",\n \"lossMtcCount\": \"\",\n \"lossMtcPaid\": \"\",\n \"lossTglCount\": \"\",\n \"lossTglPaid\": \"\",\n \"lossNtlCount\": \"\",\n \"lossNtlPaid\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "submission", "description": "", "item": [ { "name": "{displayId}", "description": "", "item": [ { "id": "3ad582f0-6736-4e08-aa60-74c10dd5e8c5", "name": "Get Submission Status", "request": { "name": "Get Submission Status", "description": { "content": "Retrieve the current status and details of a submission by its display ID.\n\nThe response uses a two-part model: `submissionStatus.status` reflects the **latest transaction** (which may be an in-progress endorsement), while `coverages`, `vehicles`, `drivers`, `insuredInformation`, and `premiumFinanceDetails` reflect the **effective (last-bound) policy**. This means a pending endorsement is visible in `status` without blanking out the coverage the bound policy still provides. `account_standing` reports whether that effective policy is `Active`, `Canceled`, or `Not In Force`.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of extra sections to include. When omitted, documents are NOT returned (faster — ideal for status polling). Pass `documents` to include a `documents` section with signed S3 download URLs keyed by transaction (`new_business`, `endorsement_1`, ...).", "type": "text/plain" }, "key": "include", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) Submission display ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b38a9551-8635-4f11-8f91-ce15e10dfc0b", "name": "quote success", "originalRequest": { "url": { "path": [ "submission", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of extra sections to include. When omitted, documents are NOT returned (faster — ideal for status polling). Pass `documents` to include a `documents` section with signed S3 download URLs keyed by transaction (`new_business`, `endorsement_1`, ...).", "type": "text/plain" }, "key": "include", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"insuredInformation\": [\n {\n \"legal_name\": \"\",\n \"mailing_address\": \"\",\n \"mailing_city\": \"\",\n \"mailing_state\": \"\",\n \"mailing_zip\": \"\"\n },\n {\n \"legal_name\": \"\",\n \"mailing_address\": \"\",\n \"mailing_city\": \"\",\n \"mailing_state\": \"\",\n \"mailing_zip\": \"\"\n }\n ],\n \"submissionStatus\": [\n {\n \"submission_number\": \"\",\n \"status\": \"\",\n \"pending_status\": \"\",\n \"calculated_status\": \"\",\n \"account_standing\": \"Not In Force\"\n },\n {\n \"submission_number\": \"\",\n \"status\": \"\",\n \"pending_status\": \"\",\n \"calculated_status\": \"\",\n \"account_standing\": \"Not In Force\"\n }\n ],\n \"coverages\": [\n {\n \"al\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"apd\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"mtc\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"tgl\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"ntl\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ]\n },\n {\n \"al\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"apd\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"mtc\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"tgl\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ],\n \"ntl\": [\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n },\n {\n \"limit\": \"\",\n \"premium\": \"\",\n \"deductible\": \"\",\n \"policy_number\": \"\",\n \"policy_effective_date\": \"\",\n \"policy_expiration_date\": \"\",\n \"carrier\": \"\",\n \"carrier_naic\": \"\"\n }\n ]\n }\n ],\n \"vehicles\": [\n {\n \"equipment_type\": \"\",\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"make\": \"\",\n \"year\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\",\n \"loss_payee\": \"\"\n },\n {\n \"equipment_type\": \"\",\n \"vin\": \"\",\n \"includeAPDTowing\": \"\",\n \"make\": \"\",\n \"year\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\",\n \"loss_payee\": \"\"\n }\n ],\n \"broker\": [\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"agency_name\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"agency_name\": \"\",\n \"address\": \"\",\n \"phone\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52ff1e86-dfa9-4a18-8be8-9c68612e39b5", "name": "error", "originalRequest": { "url": { "path": [ "submission", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated list of extra sections to include. When omitted, documents are NOT returned (faster — ideal for status polling). Pass `documents` to include a `documents` section with signed S3 download URLs keyed by transaction (`new_business`, `endorsement_1`, ...).", "type": "text/plain" }, "key": "include", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "transactions", "description": "", "item": [ { "id": "840c46a3-1a3e-41cd-9a15-3751f4cd9957", "name": "List Submission Transactions", "request": { "name": "List Submission Transactions", "description": { "content": "List every transaction on a submission (new business plus each endorsement, reinstatement, and cancellation) with a lightweight status summary. Use this to track how a policy has changed over time without pulling each transaction's full detail.\n\nResults are scoped to the calling partner's own submissions. A display ID that does not exist, or that belongs to another company, returns `404` — existence is never revealed to a non-owner.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) Submission display ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ea0c4550-ce06-4c72-a270-d7daee30a80d", "name": "Transaction list", "originalRequest": { "url": { "path": [ "submission", ":displayId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"display_id\": \"\",\n \"transaction_count\": \"\",\n \"endorsement_count\": \"\",\n \"transactions\": [\n {\n \"transaction_number\": \"\",\n \"transaction_type\": \"NEW_BUSINESS\",\n \"status\": \"\",\n \"effective_date\": \"\"\n },\n {\n \"transaction_number\": \"\",\n \"transaction_type\": \"CANCELLATION\",\n \"status\": \"\",\n \"effective_date\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "700019ed-6e18-432d-b0f0-eb7b67684f5a", "name": "Submission not found, or not owned by the calling partner", "originalRequest": { "url": { "path": [ "submission", ":displayId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "public-reply", "description": "", "item": [ { "id": "461e6747-88ed-4c11-b914-936043fec75b", "name": "Post a Public Reply", "request": { "name": "Post a Public Reply", "description": { "content": "Post a public reply / note back onto a submission — the inbound counterpart to the outbound `submission.public_reply` webhook. The note is recorded on the submission and is visible to Cover Whale staff on the account's Notes tab; it does not trigger a webhook back to you.\n\nScoped to the calling partner's own submissions. A display ID that does not exist, or that belongs to another company, returns `404` — existence is never revealed to a non-owner.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", "public-reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) Submission display ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6b509ff0-2741-4b9e-a6e4-eef7ee2b9cf7", "name": "Reply recorded", "originalRequest": { "url": { "path": [ "submission", ":displayId", "public-reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"note_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc3563a7-7341-447a-8f92-f59e34b57da1", "name": "Submission not found, or not owned by the calling partner", "originalRequest": { "url": { "path": [ "submission", ":displayId", "public-reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12b62618-9b8d-46be-9c42-0ba0d43046a9", "name": "Validation error (e.g. missing or empty content)", "originalRequest": { "url": { "path": [ "submission", ":displayId", "public-reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{transactionId}", "description": "", "item": [ { "id": "275d2939-41e6-4d47-a52d-518dd3429915", "name": "Update Submission", "request": { "name": "Update Submission", "description": { "content": "Updates a submission's fields (address, radius, limits, loss history, etc.). Only sends fields that need to change.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"dba_name\": \"\",\n \"legal_name\": \"\",\n \"years_business\": \"\",\n \"phy_street\": \"\",\n \"phy_city\": \"\",\n \"phy_state\": \"\",\n \"phy_zip\": \"\",\n \"radius_0_50\": \"\",\n \"radius_51_200\": \"\",\n \"radius_201_500\": \"\",\n \"radius_501\": \"\",\n \"limit_al\": \"\",\n \"mtc_limit_option\": \"\",\n \"loss_count_al_year1\": \"\",\n \"loss_paid_al_year1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "18454894-2ab6-4796-ba82-cc276893016e", "name": "Submission updated", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"dba_name\": \"\",\n \"legal_name\": \"\",\n \"years_business\": \"\",\n \"phy_street\": \"\",\n \"phy_city\": \"\",\n \"phy_state\": \"\",\n \"phy_zip\": \"\",\n \"radius_0_50\": \"\",\n \"radius_51_200\": \"\",\n \"radius_201_500\": \"\",\n \"radius_501\": \"\",\n \"limit_al\": \"\",\n \"mtc_limit_option\": \"\",\n \"loss_count_al_year1\": \"\",\n \"loss_paid_al_year1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"submission_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f906ee17-69d6-4d1f-b354-315db6c76bcd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"dba_name\": \"\",\n \"legal_name\": \"\",\n \"years_business\": \"\",\n \"phy_street\": \"\",\n \"phy_city\": \"\",\n \"phy_state\": \"\",\n \"phy_zip\": \"\",\n \"radius_0_50\": \"\",\n \"radius_51_200\": \"\",\n \"radius_201_500\": \"\",\n \"radius_501\": \"\",\n \"limit_al\": \"\",\n \"mtc_limit_option\": \"\",\n \"loss_count_al_year1\": \"\",\n \"loss_paid_al_year1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1ac84b0c-9dc3-4ca4-a16d-ec50ebcff8b0", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"dba_name\": \"\",\n \"legal_name\": \"\",\n \"years_business\": \"\",\n \"phy_street\": \"\",\n \"phy_city\": \"\",\n \"phy_state\": \"\",\n \"phy_zip\": \"\",\n \"radius_0_50\": \"\",\n \"radius_51_200\": \"\",\n \"radius_201_500\": \"\",\n \"radius_501\": \"\",\n \"limit_al\": \"\",\n \"mtc_limit_option\": \"\",\n \"loss_count_al_year1\": \"\",\n \"loss_paid_al_year1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9678fb16-d5cc-4c12-897c-068ac80ea2dd", "name": "Submission not available for updates", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"dba_name\": \"\",\n \"legal_name\": \"\",\n \"years_business\": \"\",\n \"phy_street\": \"\",\n \"phy_city\": \"\",\n \"phy_state\": \"\",\n \"phy_zip\": \"\",\n \"radius_0_50\": \"\",\n \"radius_51_200\": \"\",\n \"radius_201_500\": \"\",\n \"radius_501\": \"\",\n \"limit_al\": \"\",\n \"mtc_limit_option\": \"\",\n \"loss_count_al_year1\": \"\",\n \"loss_paid_al_year1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "details", "description": "", "item": [ { "id": "9cf10a13-a23f-4b3b-a8a3-ef945d47f953", "name": "Get Submission Details", "request": { "name": "Get Submission Details", "description": { "content": "Returns comprehensive submission data including coverages, vehicles, drivers, trailers, and insured info.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4a8d603c-3263-413e-b729-675f4b80a8d6", "name": "Submission details", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"status\": \"\",\n \"status_code\": \"\",\n \"insured\": {},\n \"dates\": {},\n \"coverages\": {},\n \"units\": {},\n \"drivers\": [\n {\n \"isOwner\": \"\"\n },\n {\n \"isOwner\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "206a03ce-44c7-41a8-a73a-3bfdf699d515", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0bb79c1d-8d94-4ebd-8a56-f33ba82e7274", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "documents", "description": "", "item": [ { "name": "{type}", "description": "", "item": [ { "id": "1a2a873b-8d54-4199-bdb9-85cdcdb00d77", "name": "Download Document", "request": { "name": "Download Document", "description": { "content": "Downloads a submission document by type. Returns the PDF as a streamed response.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "documents", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "binder_al", "key": "type", "disabled": false, "description": { "content": "(Required) Document type", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6dc702c8-3de6-4bef-9d90-6e622047d684", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "documents", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88fe8b4f-ddb2-4b81-bbbd-f9f21955751c", "name": "Submission or document not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "documents", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffa38fb2-04f1-4b9e-9329-8902f8035775", "name": "Invalid document type", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "documents", ":type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "recalculate-rates", "description": "", "item": [ { "id": "a3cb08b7-e688-44b6-a4f8-5d14043470a9", "name": "Recalculate Rates", "request": { "name": "Recalculate Rates", "description": { "content": "Triggers a full premium recalculation on the submission. Admin-only.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "recalculate-rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "364c1263-aa60-4c50-a6d5-7113873204c3", "name": "Rates recalculated", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "recalculate-rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"rates\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d040d815-b8a4-41b9-be45-5ad1c75d8518", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "recalculate-rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c94eafe0-734f-4a23-97fe-699aef7bafcc", "name": "Admin only", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "recalculate-rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c803a4eb-85ff-44e9-a729-3abf89616cbf", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "recalculate-rates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "taxes-fees", "description": "", "item": [ { "id": "fce58ce9-e652-4d64-9089-21e32bc7da35", "name": "Get Taxes and Fees", "request": { "name": "Get Taxes and Fees", "description": { "content": "Returns a detailed taxes and fees breakdown per coverage line.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "taxes-fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2fa02610-66d6-408d-b18c-83d6fbcf95ce", "name": "Taxes and fees breakdown", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "taxes-fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"coverages\": {},\n \"surplus_lines_service_charges\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2a519ce-19e0-4214-89c6-6990b43ed0e4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "taxes-fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8676bf2b-0f6d-482e-b8e1-4a837377a065", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "taxes-fees" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "vehicle", "description": "", "item": [ { "id": "2895b122-bae7-4341-bef7-e9128e93136d", "name": "Add Vehicle", "request": { "name": "Add Vehicle", "description": { "content": "Adds a vehicle (power unit) to a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "aa3d919f-33c5-43ce-9a89-84f15d33a5a5", "name": "Vehicle added", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"vehicle_id\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb629cb-6aff-47aa-9ad7-4c885d5cdba7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "538c5fc2-fba0-4079-8cc5-36f03468c896", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "015a4eff-9e38-4d90-a3b0-b07d8bdf1ceb", "name": "Validation error", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{vehicleId}", "description": "", "item": [ { "id": "54bd1396-ec4b-4aaa-a3fe-c84fd5cdc0d1", "name": "Update Vehicle", "request": { "name": "Update Vehicle", "description": { "content": "Updates fields on an existing vehicle. Only send fields that need to change.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "vehicleId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5a772d80-63da-4adf-a5bc-9290bda54e73", "name": "Vehicle updated", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"vehicle_id\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"updated_fields\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b0c39c4-2be8-4d07-bfe8-deb6f55b54ae", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "849135ef-ad2a-45b0-810e-064921b10735", "name": "Submission or vehicle not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76d7e52f-d7fe-4dcd-bef8-518966373f5c", "name": "Validation error", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"class\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ffeb446-cb08-46d0-a903-7aa7d8e9647d", "name": "Remove Vehicle", "request": { "name": "Remove Vehicle", "description": { "content": "Removes a vehicle from a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "vehicleId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "cbf065f2-7ba5-4314-a15c-9160a7654ec2", "name": "Vehicle removed", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9081b20-78cb-4f72-9f71-f7e9ec64c486", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "04f54c42-52f2-4d53-a161-0a483a0f9027", "name": "Submission or vehicle not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "vehicle", ":vehicleId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "driver", "description": "", "item": [ { "id": "ded8b89a-9b14-4755-88d3-1df4d0b9ab97", "name": "Add Driver", "request": { "name": "Add Driver", "description": { "content": "Adds a driver to a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "driver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"Y\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9597869a-eac3-48e2-b495-de3ecac865e7", "name": "Driver added", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"Y\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"driver_id\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3e8a30a-a597-47cd-8bc7-6cb62273f8fe", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"Y\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f66bab6a-9811-45a2-a845-9e79e7eda93b", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"Y\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a3e2236-5ae4-4a20-bd6c-d9d0c4dc342a", "name": "Validation error", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"Y\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{driverId}", "description": "", "item": [ { "id": "65bb01eb-6469-4ed5-972f-9c5224c4e457", "name": "Update Driver", "request": { "name": "Update Driver", "description": { "content": "Updates fields on an existing driver. Only send fields that need to change.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "driverId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"N\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "593246e0-7766-42a3-80ee-318267c2f344", "name": "Driver updated", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"N\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"driver_id\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"updated_fields\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bcd364c-8f2e-46db-9e49-67c4e0c7003a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"N\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "077345bd-05fc-4bbe-81f1-c264d0e1b95f", "name": "Submission or driver not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"N\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e336915-77c3-42af-bd02-96869b62644e", "name": "Validation error", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name_first\": \"\",\n \"name_last\": \"\",\n \"driver_license_state\": \"\",\n \"driver_license_number\": \"\",\n \"driver_date_of_birth\": \"\",\n \"covered\": \"N\",\n \"years_cdl_experience\": \"\",\n \"months_cdl_experience\": \"\",\n \"accidents_total\": \"\",\n \"suspensions_total\": \"\",\n \"violations_total\": \"\",\n \"major_violations_total\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aea69e39-d3a0-40f7-8941-bd70ac83f0f5", "name": "Remove Driver", "request": { "name": "Remove Driver", "description": { "content": "Removes a driver from a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "driverId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "dabca78a-600a-4a4b-823c-69f472ff06aa", "name": "Driver removed", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35fcd1ac-54a2-48af-acd0-dde3139cc512", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "093fc739-56e9-4a67-bab5-e5ae0e17fdeb", "name": "Submission or driver not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "driver", ":driverId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "trailer", "description": "", "item": [ { "id": "cf4c6f16-b838-4363-ab0b-ae2dc4b0e142", "name": "Add Trailer", "request": { "name": "Add Trailer", "description": { "content": "Adds a trailer to a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"ownership\": \"owned\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "faa03bad-989c-40a6-851c-01bb37996eae", "name": "Trailer added", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"ownership\": \"owned\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"trailer_id\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8eaec8-516d-4cc9-b308-1b0202f26984", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"ownership\": \"owned\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d57e4e07-b497-4661-a201-9d1efc78c0b7", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"ownership\": \"owned\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98303c58-a0d9-4026-be4f-d523bdc2c99b", "name": "Validation error", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vehicle_id_number\": \"\",\n \"year\": \"\",\n \"make\": \"\",\n \"model\": \"\",\n \"value\": \"\",\n \"body_type\": \"\",\n \"ownership\": \"owned\",\n \"deductible\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{trailerId}", "description": "", "item": [ { "id": "45d86f95-58da-45da-a919-5c28a0efddc7", "name": "Remove Trailer", "request": { "name": "Remove Trailer", "description": { "content": "Removes a trailer from a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer", ":trailerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "trailerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f60e8a64-dd5d-44bf-87b5-00a6e77e4eeb", "name": "Trailer removed", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer", ":trailerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2cbf9d1-216c-47f7-a344-2d37aad2984c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer", ":trailerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07fa919a-62d8-4218-9e08-252e7bac5f98", "name": "Submission or trailer not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "trailer", ":trailerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "quote-endorsement", "description": "", "item": [ { "id": "8cf1a74a-1b35-4490-8c78-9ea26784af97", "name": "Quote Endorsement", "request": { "name": "Quote Endorsement", "description": { "content": "Recalculates rates on an endorsement and sets its status to Quoted. Only applicable to endorsement transactions.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "quote-endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "98114cd0-393a-41d4-a081-e196d39b1588", "name": "Endorsement quoted", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "quote-endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"endorsement_status\": \"\",\n \"rates\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca9e5e27-208d-4c29-a0c4-18d60f0e7d24", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "quote-endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "427652e4-0558-49e4-8c51-0c6df346e9bf", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "quote-endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0b46dc0-9a07-47f2-9829-bf8b4cb671c1", "name": "Not an endorsement or not in quotable status", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "quote-endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "endorsement", "description": "", "item": [ { "id": "6f5f23d4-f6f3-4c31-883f-84a9078c43ae", "name": "Create Endorsement", "request": { "name": "Create Endorsement", "description": { "content": "Creates a new endorsement on a bound policy. The submission must be in a bound state.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) Submission display ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Transaction ID of the bound submission", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8d7fc739-28aa-4447-b91f-c052d479af37", "name": "Endorsement created", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"endorsement_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8486fcf4-2b7b-48b3-8a5d-061b9e809132", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3440e3ba-7a4a-452b-b69a-0eba5641361b", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aee437a4-5c2b-4761-81ba-9c4e9606b183", "name": "Not allowed to create endorsement", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "endorsement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cancel-approve", "description": "", "item": [ { "id": "b5fab84f-881b-4fdf-8f11-7cb7fe947873", "name": "Approve Cancellation", "request": { "name": "Approve Cancellation", "description": { "content": "Approves a pending cancellation endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel-approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"internal_cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"cancellation_reason_broker\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "49196935-b83f-46a6-8f06-c9069930b868", "name": "Cancellation approved", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel-approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"internal_cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"cancellation_reason_broker\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"submission_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2406d37e-ee8a-4131-b4d5-83026ce6aaeb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel-approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"internal_cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"cancellation_reason_broker\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53c3a9e9-4387-4363-8aca-bf36231327d6", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel-approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"internal_cancellation_reason\": [\n \"\",\n \"\"\n ],\n \"cancellation_reason_broker\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cancel", "description": "", "item": [ { "id": "f3ccefa1-53a0-407f-bec2-fdae93086f39", "name": "Execute Cancellation", "request": { "name": "Execute Cancellation", "description": { "content": "Executes the cancellation on an approved cancellation endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d51f1d41-de47-47cf-b23c-809150fa13c8", "name": "Cancellation executed", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"submission_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c7f3e22-378b-424d-b95a-d64e5c2f7cf2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2f340dae-a9dc-4fff-bbe8-f045c2bdb071", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason\": \"\",\n \"cancel_reason_others\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reinstatement", "description": "", "item": [ { "id": "86701f2f-4e88-4df9-8772-c46616d6b8fb", "name": "Create Reinstatement", "request": { "name": "Create Reinstatement", "description": { "content": "Creates a reinstatement from a cancelled submission. Admin only.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "reinstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "88b41c3f-451d-4da6-a2f7-32c3e33d5583", "name": "Reinstatement created", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "reinstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"reinstatement_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6745bfc4-1b8b-42e1-bc39-99527a900cc0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "reinstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f80ef19-c1d5-4098-b225-162b3ebde511", "name": "Only admins can create reinstatements", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "reinstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6132f3e5-d0a2-4265-b6ac-1462cb08b249", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "reinstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4cdfa19b-e516-41e2-8a71-7fa7b115356e", "name": "Reinstatement not available for this status", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "reinstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "non-renewal", "description": "", "item": [ { "id": "5cdede60-60b2-4fa7-b2e6-d6966fd0a5f7", "name": "Non-Renewal", "request": { "name": "Non-Renewal", "description": { "content": "Marks a policy for non-renewal. Generates non-renewal notice PDF and sends email.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "non-renewal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nonRenewal_reason\": \"\",\n \"other_nonRenewal_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9d096448-95c8-403c-88be-8af397bcf9b7", "name": "Non-renewal processed", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "non-renewal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nonRenewal_reason\": \"\",\n \"other_nonRenewal_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"submission_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a871b50-1b71-427b-94f9-87e2095c9b05", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "non-renewal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nonRenewal_reason\": \"\",\n \"other_nonRenewal_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b40fbe8-247f-445f-b552-caa4ca551e25", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "non-renewal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nonRenewal_reason\": \"\",\n \"other_nonRenewal_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a64d0d2-8abe-40a9-945b-ae875d354222", "name": "Non-renewal not available", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "non-renewal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nonRenewal_reason\": \"\",\n \"other_nonRenewal_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "decline", "description": "", "item": [ { "id": "2756425f-0d08-4c9a-9556-84b15b5c48f2", "name": "Decline Submission", "request": { "name": "Decline Submission", "description": { "content": "Declines a submission or endorsement.", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", ":transactionId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decline_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9be4322b-fa89-492e-9559-f73df4f5e866", "name": "Submission declined", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decline_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"submission_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c90446c4-5620-4288-8e18-b0c5e83ff1b3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decline_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d714bb0e-9b65-4db3-83e6-b990617aa7b9", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decline_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4d8241d-0eb1-4860-ba31-148d8896285f", "name": "Decline not available", "originalRequest": { "url": { "path": [ "submission", ":displayId", ":transactionId", "decline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decline_note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "cancel-request", "description": "", "item": [ { "id": "16b8018c-4fa7-40a8-8b4f-49f84ec9b8d9", "name": "Request Cancellation", "request": { "name": "Request Cancellation", "description": { "content": "Creates a cancellation endorsement (first step of the cancellation workflow).", "type": "text/plain" }, "url": { "path": [ "submission", ":displayId", "cancel-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) Submission display ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\",\n \"effective_date_transaction_al\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9da3fb45-f4b2-453e-a210-ff4204d20aac", "name": "Cancellation request created", "originalRequest": { "url": { "path": [ "submission", ":displayId", "cancel-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\",\n \"effective_date_transaction_al\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"submission_number\": \"\",\n \"transaction_id\": \"\",\n \"cancellation_status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95134b86-fa44-4f2f-bd3c-8fbe6cc03d6f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "submission", ":displayId", "cancel-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\",\n \"effective_date_transaction_al\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "236088d2-fb66-4fb9-bd3d-b3a23ad47593", "name": "Submission not found", "originalRequest": { "url": { "path": [ "submission", ":displayId", "cancel-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\",\n \"effective_date_transaction_al\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc696858-2c56-4ef2-86eb-0656fa2881d4", "name": "Cancel request not available", "originalRequest": { "url": { "path": [ "submission", ":displayId", "cancel-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"effective_date_transaction\": \"\",\n \"effective_date_transaction_al\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "webhook-subscriptions", "description": "", "item": [ { "id": "2d580d93-2375-4894-8f21-6aee44473364", "name": "List Webhook Subscriptions", "request": { "name": "List Webhook Subscriptions", "description": { "content": "List every webhook subscription belonging to your account. The signing `secret` is never returned here — it is shown only once, when a subscription is created or its secret is rotated.", "type": "text/plain" }, "url": { "path": [ "webhook-subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "24a69cd9-db7e-4597-9062-db4f8fc10dfd", "name": "Your subscriptions", "originalRequest": { "url": { "path": [ "webhook-subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"active\": \"\",\n \"secret_rotated_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"active\": \"\",\n \"secret_rotated_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80d9522b-5a5e-469d-8b08-2a4ef853fe52", "name": "Create a Webhook Subscription", "request": { "name": "Create a Webhook Subscription", "description": { "content": "Register an HTTPS endpoint to receive events for your account's submissions. **The signing `secret` is returned only in this response (and on rotate-secret) — store it now; it is never shown again.** Use it to verify the signature on every delivery.\n\nSubscriptions are scoped to your account: you only ever receive events for submissions your company owns.", "type": "text/plain" }, "url": { "path": [ "webhook-subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"submission.quoted\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fdbad92a-5f5d-4142-be9c-cf98c6f688e5", "name": "Subscription created — `secret` is included here only", "originalRequest": { "url": { "path": [ "webhook-subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"submission.quoted\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"company_id\": \"\",\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"active\": \"\",\n \"secret\": \"\",\n \"secret_rotated_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab3067b-1822-4579-9495-c4ff6f326e3e", "name": "Validation error (missing/invalid endpoint_url or event_types)", "originalRequest": { "url": { "path": [ "webhook-subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"submission.quoted\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "70e6f20b-4986-427a-995a-6dbdf388b6d1", "name": "Get a Webhook Subscription", "request": { "name": "Get a Webhook Subscription", "description": { "content": "Retrieve one of your subscriptions by id. A subscription that does not exist, or that belongs to another account, returns `404`.", "type": "text/plain" }, "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3f1dba8f-8b0a-4c4b-b74b-ccf6fdf9e385", "name": "The subscription", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"company_id\": \"\",\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"active\": \"\",\n \"secret_rotated_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "069da7dc-2674-4e27-9711-643ae95777ef", "name": "Not found (or not owned by your account)", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdab21b6-6107-4d54-bb1a-38ef4a4403a6", "name": "Update a Webhook Subscription", "request": { "name": "Update a Webhook Subscription", "description": { "content": "Update a subscription's endpoint URL, event types, and/or active flag. All fields are optional — send only what you want to change. Set `active: false` to pause deliveries without deleting the subscription.", "type": "text/plain" }, "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\"\n ],\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4b2a7f36-14bd-46d3-8d8a-d46cdd4e41a8", "name": "Updated subscription", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\"\n ],\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"company_id\": \"\",\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"active\": \"\",\n \"secret_rotated_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c21cbef0-23f3-4410-90ff-d1055b60667d", "name": "Not found (or not owned by your account)", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\"\n ],\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd629334-dbdb-4832-918d-a2323ef6b941", "name": "Delete a Webhook Subscription", "request": { "name": "Delete a Webhook Subscription", "description": { "content": "Permanently delete a subscription. Deliveries stop immediately. Returns `204` with no body.", "type": "text/plain" }, "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3790d403-8ed9-418b-8925-8c6bc7abeed3", "name": "Deleted (no content)", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fbee7fbb-260a-49ef-82fb-e75bba78c860", "name": "Not found (or not owned by your account)", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "rotate-secret", "description": "", "item": [ { "id": "36207105-01f2-4d14-9af1-9a9c92ac5609", "name": "Rotate a Subscription Secret", "request": { "name": "Rotate a Subscription Secret", "description": { "content": "Generate a new signing secret for a subscription. **The new `secret` is returned only in this response** — store it now. The previous secret keeps verifying for a short grace window so in-flight deliveries signed with it still validate.", "type": "text/plain" }, "url": { "path": [ "webhook-subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "890ffe9b-36c4-4c31-8479-1f2f73bb053a", "name": "Secret rotated — new `secret` included here only", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"company_id\": \"\",\n \"endpoint_url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"active\": \"\",\n \"secret\": \"\",\n \"secret_rotated_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf89c65a-e9df-4c90-9880-84299ae5b7c1", "name": "Not found (or not owned by your account)", "originalRequest": { "url": { "path": [ "webhook-subscriptions", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "bind", "description": "", "item": [ { "name": "{displayId}", "description": "", "item": [ { "id": "beaab128-db9b-452f-ab02-79db81bb8734", "name": "Bind a Quoted Submission", "request": { "name": "Bind a Quoted Submission", "description": { "content": "Submit a bind request for a quoted submission. The submission must be in 'Quoted' status.", "type": "text/plain" }, "url": { "path": [ "bind", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "displayId", "disabled": false, "description": { "content": "(Required) The submission display ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"coverage\": {\n \"includeAPD\": \"\",\n \"includeAL\": \"\",\n \"includeTGL\": \"\",\n \"includeNTL\": \"\",\n \"includeMTC\": \"\",\n \"optInCWFinancing\": \"\",\n \"electTRIA\": \"\",\n \"effectiveDate\": \"\"\n },\n \"bindingMethod\": {\n \"signFirst\": \"\",\n \"retailAgentEmail\": \"\",\n \"insuredEmail\": \"\",\n \"insuredFullName\": \"\",\n \"electronicSignature\": \"\"\n },\n \"shippingAddress\": {\n \"dashcam_shipping_address\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a50d7e83-ca9d-4422-ae6a-d54b61074e6a", "name": "Bind request submitted successfully", "originalRequest": { "url": { "path": [ "bind", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"coverage\": {\n \"includeAPD\": \"\",\n \"includeAL\": \"\",\n \"includeTGL\": \"\",\n \"includeNTL\": \"\",\n \"includeMTC\": \"\",\n \"optInCWFinancing\": \"\",\n \"electTRIA\": \"\",\n \"effectiveDate\": \"\"\n },\n \"bindingMethod\": {\n \"signFirst\": \"\",\n \"retailAgentEmail\": \"\",\n \"insuredEmail\": \"\",\n \"insuredFullName\": \"\",\n \"electronicSignature\": \"\"\n },\n \"shippingAddress\": {\n \"dashcam_shipping_address\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46431d58-050e-45c4-9393-46b4e6936e95", "name": "Unauthorized – missing or invalid AccessToken", "originalRequest": { "url": { "path": [ "bind", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"coverage\": {\n \"includeAPD\": \"\",\n \"includeAL\": \"\",\n \"includeTGL\": \"\",\n \"includeNTL\": \"\",\n \"includeMTC\": \"\",\n \"optInCWFinancing\": \"\",\n \"electTRIA\": \"\",\n \"effectiveDate\": \"\"\n },\n \"bindingMethod\": {\n \"signFirst\": \"\",\n \"retailAgentEmail\": \"\",\n \"insuredEmail\": \"\",\n \"insuredFullName\": \"\",\n \"electronicSignature\": \"\"\n },\n \"shippingAddress\": {\n \"dashcam_shipping_address\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ba120a4-8e75-4984-b5b8-bc4d8f4c4c76", "name": "Validation error or submission not in quoted status", "originalRequest": { "url": { "path": [ "bind", ":displayId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "AccessToken", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "AccessToken", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"coverage\": {\n \"includeAPD\": \"\",\n \"includeAL\": \"\",\n \"includeTGL\": \"\",\n \"includeNTL\": \"\",\n \"includeMTC\": \"\",\n \"optInCWFinancing\": \"\",\n \"electTRIA\": \"\",\n \"effectiveDate\": \"\"\n },\n \"bindingMethod\": {\n \"signFirst\": \"\",\n \"retailAgentEmail\": \"\",\n \"insuredEmail\": \"\",\n \"insuredFullName\": \"\",\n \"electronicSignature\": \"\"\n },\n \"shippingAddress\": {\n \"dashcam_shipping_address\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "AccessToken", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.coverwhale.dev/v1" } ], "info": { "_postman_id": "11b2e20c-c67e-4a30-b7aa-3f1463dcc8f9", "name": "Cover Whale API V1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Contact Support:\n Name: Cover Whale API Team", "type": "text/plain" } } }