Odyssey API Documentation (1.1)

Download OpenAPI specification:Download

Authenticate

header Parameters

X-Client-Key

required

string

Client key

Request Body schema: application/json

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

Content type

application/json

{"accessToken": "string",
"accessTokenExpiresAt": "string",
"tokenType": "bearer"
}

Create a flood quote

Authorizations:

bearer

header Parameters

X-Client-Key

required

string

Client key

Request Body schema: application/json

buildingDeductible required	integer <int32> (buildingDeductible) Enum: 0 1000 1250 1500 2000 5000 10000 25000 50000 Building coverage deductible
contentsDeductible required	integer <int32> (contentsDeductible) Enum: 0 1000 1250 1500 2000 5000 10000 25000 50000 Contents coverage deductible
totalCoverageBuilding required	integer <int32> (totalCoverageBuilding) Building coverage maximums are as follows: Single-Family Home - $250,000, Residential Manufactured/Mobile Home - $250,000, Residential Condominium Unit (in Residential Building) - $250,000, All Other Building Descriptions - None, Two-to-Four Family Building - $250,000, Other Residential Building - $500,000, Residential Condominium Building - Not to exceed the lesser of the building's replacement cost or total number of units X $250,000, Non-Residential Building - $500,000, Non-Residential Manufactured/Mobile Building - $500,000, Non-Residential Unit - None.
totalCoverageContents required	integer <int32> (totalCoverageContents) Contents covergage maximums are as follows: Single-Family Home - $100,000, Residential Manufactured/Mobile Home - $100,000, Residential Condominium Unit (in Residential Building) - $100,000, All Other Building Descriptions - $100,000, Two-to-Four Family Building - $100,000, Other Residential Building - $100,000, Residential Condominium Building - $100,000, Non-Residential Building - $500,000, Non-Residential Manufactured/Mobile Building - $500,000, Non-Residential Unit - $500,000.
effectiveDate required	string <date>
	object
newRolloverTransferType	string (newRolloverTransferType) Enum: "N" "R" "E" "Z" "T" "O" Code that indicates the type of new business being reported by the WYO. Default is N. N:New Issue; R:Rollover; E:(Canceled effective May 1, 2005); Z: Rewritten for TRRP cancellation reason codes 03, 22, 24, 25; T: Transfer; O: RiskRating2.0 Opt-In option Only available until March 31, 2022
addressLine1 required	string
adddressLine2	string
city required	string
state required	string
zipCode required	string
zipPlus4	string
buildingDescription required	string (buildingDescription) Enum: "MAINHOUSEBLDG" "DETACHEDGUESTHOUSE" "DETACHEDGARAGE" "AGRICULTURALBLDG" "COMMERCIAL" "RECREATIONBLDG" "TOOLSTORAGESHED" "OTHER" "ENTIRECOOPERATIVEBLDG" "ENTIREAPARTMENTBLDG" "COOPERATIVEUNIT" "APARTMENTUNIT" "RESIDENTIALCONDOUNITRB" "RESIDENTIALCONDOUNITNRB" "ENTIRERESCONDOBLDG" "OTHERNONRESIDENTIAL" "GOVOWNED" "HOUSEOFWORSHIP" Indicates the description of use of the insured building. MAINHOUSEBLDG: Main House/Building; DETACHEDGUESTHOUSE: Detached Guest House; DETACHEDGARAGE: Detached Garage; AGRICULTURALBLDG: Agricultural Building; COMMERCIAL: Commercial; RECREATIONBLDG: Recreation Building; TOOLSTORAGESHED: Tool/Storage Shed; OTHER: Other; ENTIRECOOPERATIVEBLDG: Entire Cooperative Building; ENTIREAPARTMENTBLDG: Entire Apartment Building; COOPERATIVEUNIT: Cooperative Unit; APARTMENTUNIT: Apartment Uni;, RESIDENTIALCONDOUNITRB: Residential Condo Unit - Residential Building; RESIDENTIALCONDOUNITNRB: Residential Condo Unit - Non-Residential Building; ENTIRERESCONDOBLDG: Entire Residential Condominium Building; OTHERNONRESIDENTIAL: Other Non-Residential Type; GOVOWNED: Government Owned; HOUSEOFWORSHIP: House of Worship
constructionType	string (constructionType) Enum: "FRAME" "MASONRY" "OTHER" Indicated construction type. FRAME: Frame; MASONRY: Masonry; OTHER: Other
foundationType required	string (foundationType) Enum: "SLABONGRADE" "ELEVATEDONCRAWLSPACE" "BASEMENT" "ELEVATEDWITHOUTENCLOSURE" "ELEVATEDWITHENCLOSURE" "ELEVATEDWITHENCLOSURENOTPPP" Indicates the foundation type of the property. SLABONGRADE: Slab on Grade (non-elevated); ELEVATEDONCRAWLSPACE: Crawlspace (includes subgrade); BASEMENT: Basement; ELEVATEDWITHOUTENCLOSURE: Elevated without enclosure on piers, posts & piles; ELEVATEDWITHENCLOSURE: Elevated with enclosure on piers, posts & piles; ELEVATEDWITHENCLOSURENOTPPP: Elevated with enclosure not on piers, posts & piles
numberOfFloors	integer <int32>
totalSquareFootage	integer <int32>
enclosureSize	integer or null <int32>
numberOfUnits	integer <int32>
occupancyType required	string (occupancyType) Enum: "SINGLEFAMILY" "TWOFOURFAMILY" "OTHERRESIDENTIAL" "RESIDENTIALUNIT" "RESIDENTIALCONDOBUILD" "NONRESIDENTIALUNIT" "NONRESIDENTIALBUILD" "RESIDENTIALMOBILEHOME" "NONRESIDENTIALMOBILEHOME" Code indicating the use and Risk Rated occupancy type of the insured structure. SINGLEFAMILY: Single Family; TWOFOURFAMILY: Two To Four Family Building; OTHERRESIDENTIAL :Other Residentail Building; RESIDENTIALUNIT:Residential Unit; RESIDENTIALCONDOBUILD: Residential Condo Building; NONRESIDENTIALUNIT: Non-Residential Unit; NONRESIDENTIALBUILD: Non-Residential Building; RESIDENTIALMOBILEHOME: Residential Mobile/Manufactured Home; NONRESIDENTIALMOBILEHOME: Non-Residential Mobile/Manufactured Home
primaryResidence required	boolean
floorOfUnit	integer <int32>
ecDate	string <date>
ecDiagramNumber	string
topBottomFloor	string
lowestAdjacentGrade	string
topHigherFloor	string
priorNaicNumber	string
priorPolicyNumber	string
industryReplacementCost	integer <int32>
buildingOverWaterType required	string (buildingOverWaterType) Enum: "NOTOVERWATER" "FULLOVERWATER" "PARTIALLYOVERWATER" This is the type code that determines if the insured building is not over water, partially over water, or fully/entirely over water. NOTOVERWATER: Not over Water; PARTIALLYOVERWATER: Partially over Water; FULLOVERWATER: Fully/Entirely over Water
isPropertyRental required	boolean
isUnderConstruction required	boolean
primaryFirstName	string
primaryLastName required	string Last name of the primary insured. Can also be organization name.
phoneNumber required	string
email required	string
isInsuredOwner required	boolean
noOfElevators	integer <int32>
waitingPeriod	string (waitingPeriod) Enum: "STANDARD30" "LENDER30" "LOANNOWAIT" "MAPREVONEDAY" "ROLLOVER_RENEWAL" Waiting period for policy
applicantType	string (applicantType) Enum: "INDIVIDUAL" "BUSINESS" "ASSOCIATION" Applicant Type
isInsuredNonProfitEntity	boolean (isInsuredNonProfitEntity) Is the Policyholder/Member a non-profit entity
isInsuredHasSmallBusiness	boolean (isInsuredHasSmallBusiness) Is the Policyholder/Member a small business with less than 100 employees?
condoOwnership	boolean (condoOwnership) Is the policyholder/Member a condominium association?
priorLoanClosingDate	string <date>
priorPolicyExpiryDate	string <date>
priorNewBusinessDate	string <date>
isMobileHome	boolean (isMobileHome) Is the Structure a Mobile Home?
datetOfConstructionSource	string (datetOfConstructionSource) Enum: "LOCATEDIN" "LOCATEDOUTSIDE" This is the type code that determines if Located In a Mobile Home Park (LOCATEDIN) or Subdivision or Located Outside a Mobile Home Park or Subdivision (LOCATEDOUTSIDE)
originalConstructionDate required	string <date> Construction Date / Date The Park/subdivision was established if Located In a Mobile Home Park or Subdivision / Date of Permanent Placement
substantialImprovement	boolean (substantialImprovement) Has the building been substantially improved?
isBuildingListedInNRHP	boolean (isBuildingListedInNRHP) Is building listed in the National Register of Historic Places?
substantialImprovementDate	string <date> Date of substantial improvement if building is not listed in the National Register of Historic place.
isBuildingTravelTrailer	boolean (isBuildingTravelTrailer) If Residential Mobile/Manufactured Home then If the building is a travel trailer, have the wheels and tires been removed?
homeAnchoredMethod	string (homeAnchoredMethod) Enum: "NOTANCHORED" "MANUFACTURESPECIFICATION" "MANAGMENTSPECIFICATION" "TIESTOGROUNDANCHORED" if Residential Mobile/Manufactured Home then How is the home anchored?. NOTANCHORED:Not Anchored; MANUFACTURESPECIFICATION:In Accordance with Manufacture's Specification; MANAGMENTSPECIFICATION:In Accordance with Community Floodplain Management Specification; TIESTOGROUNDANCHORED:Over-the-top or Frame Ties to Ground Anchored
serialNo	string If Residential Mobile/Manufactured Home then Serial
isPermanentFoundation	boolean (isPermanentFoundation) If Non-Residential Mobile/Manufactured Home then Is On Permanent foundation?
noOfDetatchedStructure	integer <int32> Number Of Detached Structures.
isBuildingContainME	boolean (isBuildingContainME) Does the building contain Machinery and equipment that services the building?
allMachinaryElevated	boolean (allMachinaryElevated) Is all machinery Elevated to the height of the floor above the basement or higher?
isValidElevationCertificate	boolean (isValidElevationCertificate) Do you have a valid elevation certificate?
isNewPurchase	boolean (isNewPurchase) Is this a new purchase (within the last year)?
isSellerDec	boolean (isSellerDec) Do you have sellers policy information?
isPriorNFIPPolicy	boolean (isPriorNFIPPolicy) Has the applicant had a prior NFIP policy for this structure?
isPriorNFIPLapsed	boolean (isPriorNFIPLapsed) Did the prior policy lapse while receiving a pre-firm discount?
isCommunityLapseSuspension	boolean (isCommunityLapseSuspension) Was the lapse the result of a community suspension?
hasProperFloodOpenings	boolean Does the enclosure have proper openings?
numberOfFloodOpenings	integer <int32> Number of openings
totalAreaFloodOpenings	integer <int32> Total square inches of Open Area
wereEngineeredVentsused	boolean Were engineered vents used?
quoteSourceCode	string A value can be passed in this field that can be used for reporting in the Taurus system. Example would include a special project where you need to track the success of the quote to policy conversion rati

Responses

Request samples

Payload

Content type

application/json

{"buildingDeductible": 5000,
"contentsDeductible": 5000,
"totalCoverageBuilding": 250000,
"totalCoverageContents": 20000,
"effectiveDate": "2023-10-25",
"agentOverrideInfo": {"agencyWyoCode": "",
"agentWyoCode": "",
"agentFloodCode": ""
},
"newRolloverTransferType": "N",
"addressLine1": "11515 Dutch Iris Dr",
"addressLine2": "",
"city": "Riverview",
"state": "FL",
"zipCode": "33578",
"zipPlus4": "",
"isMobileHome": false,
"buildingDescription": "MAINHOUSEBLDG",
"constructionType": "FRAME",
"foundationType": "ELEVATEDWITHENCLOSURE",
"numberOfFloors": 3,
"totalSquareFootage": 2500,
"numberOfUnits": 1,
"occupancyType": "SINGLEFAMILY",
"primaryResidence": true,
"floorOfUnit": 1,
"industryReplacementCost": 650000,
"buildingOverWaterType": "NOTOVERWATER",
"isPropertyRental": true,
"isUnderConstruction": false,
"primaryFirstName": "John",
"primaryLastName": "Doe",
"phoneNumber": "5555555555",
"email": "test@test.com",
"isInsuredOwner": true,
"noOfElevators": 2,
"waitingPeriod": "STANDARD30",
"applicantType": "INDIVIDUAL",
"isInsuredNonProfitEntity": false,
"isInsuredHasSmallBusiness": false,
"condoOwnership": false,
"PriorLoanClosingDate": "2019-03-01",
"priorPolicyExpiryDate": "2020-04-01",
"priorPolicyNumber": "",
"priorNaicNumber": "15826",
"priorNewBusinessDate": "2020-04-01",
"datetOfConstructionSource": "LOCATEDIN",
"originalConstructionDate": "1985-01-01",
"substantialImprovement": true,
"isBuildingListedInNRHP": false,
"substantialImprovementDate": "2021-02-01",
"isBuildingTravelTailer": true,
"homeAnchoredMethod": "MANUFACTURESPECIFICATION",
"serialNo": "12abc",
"isPermanentFoundation": false,
"noOfDetatchedStructure": 2,
"isBuildingContainME": false,
"allMachinaryElevated": false,
"isValidElevationCertificate": false,
"isNewPurchase": true,
"isSellerDec": true,
"isPriorNFIPPolicy": false,
"isPriorNFIPLapsed": false,
"isCommunityLapseSuspension": false,
"enclosureSize": 1500,
"ecDate": "2004-06-02",
"ecDiagramNumber": "1A",
"topBottomFloor": "5",
"lowestAdjacentGrade": "7",
"topHigherFloor": "2",
"hasProperFloodOpenings": false,
"numberOfFloodOpenings": 0,
"totalAreaFloodOpenings": 0,
"wereEngineeredVentsused": false,
"quoteSourceCode": ""
}

Response samples

Content type

application/json

{"status": true,
"data": {"quoteNumber": "string",
"quoteURL": "string",
"transactionDate": "string",
"transactionId": "string",
"code": 0,
"message": "string",
"fieldErrors": [ ],
"ruleFailures": [ ],
"policyQuoteDetails": {"uuid": "string",
"coverageAmounts": [{"coverageAmountType": "CURRENT_COVERAGE",
"buildingDeductible": 0,
"contentsDeductible": 0,
"industryReplacementCost": 0,
"totalCoverageBuilding": 0,
"totalCoverageContents": 0
}
],
"effectiveDate": "2019-08-24",
"endorsementEffectiveDate": "string",
"naicNumber": "string",
"newRolloverTransferType": "N",
"policyAssignmentType": "string",
"policyNumber": "string",
"premium": {"annualIncreaseCapDiscount": 0,
"buildingPremium": 0,
"contentsPremium": 0,
"crsDiscount": 0,
"discountedPremium": 0,
"federalPolicyFee": 0,
"fullRiskPremium": 0,
"hfiaaSurcharge": 0,
"iccPremium": 0,
"mitigationDiscounts": 0,
"newlyMappedDiscount": 0,
"otherStatutoryDiscounts": 0,
"preFirmDiscount": 0,
"probationSurcharge": 0,
"reserveFundAssessment": 0,
"totalAnnualPayment": 0,
"totalCalculatedPremium": 0,
"discountedBuildingPremium": 0,
"discountedContentsPremium": 0
},
"proratedPremium": null,
"priorNaicNumber": "string",
"priorPolicyNumber": "string",
"propertyAddress": {"addressLine1": "string",
"addressLine2": "string",
"addressType": "CLEAR",
"city": "string",
"countyFips": "string",
"deleteAddress": true,
"floodZone": "A",
"id": 0,
"nameOrDescriptiveType": "string",
"propertyBeginningStreetNumber": 0,
"state": "string",
"stateFips": "string",
"zipCode": "string",
"zipPlus4": "string"
},
"propertyCharacteristics": {"constructionDetails": {"buildingDescription": "MAINHOUSEBLDG",
"buildingOverWaterType": "NOTOVERWATER",
"constructionType": "FRAME",
"enclosureSize": 0,
"floodProofed": true,
"foundationType": "SLABONGRADE",
"hasProperFloodOpenings": true,
"numberOfFloodOpenings": 0,
"numberOfFloors": 0,
"originalConstructionDate": "2019-08-24",
"substantialImprovementDate": "string",
"totalAreaFloodOpenings": 0,
"totalSquareFootage": 0,
"buildingUnderConstruction": true
},
"elevationCertificate": "string",
"floorOfUnit": 0,
"industryGeoDetails": {"communityNumber": "string",
"currentMapDate": "string",
"emergencyProgram": true,
"floodZone": "A",
"initialFirmDate": "2019-08-24",
"latitude": 0.1,
"longitude": 0.1,
"cbrsBufferZoneDetermination": true,
"cbrsOpaBuildingConsistentUse": true
},
"machineryOrEquipmentAbove": true,
"newlyMapped": true,
"newlyMappedDiscountEligible": true,
"numberOfUnits": 0,
"occupancyType": "SINGLEFAMILY",
"postFirmConstruction": true,
"preFirmSubsidyEligible": true,
"primaryResidence": true
},
"quoteSubmittedLocalDateTime": "string",
"quoteTransactionType": "ENDORSEMENT_QUOTE",
"quoteFactors": {"cbrsSystemUnitOrOpa": "string",
"cbrsSystemUnitOrOpaYear": "string",
"crsClass": 0,
"crsExclusionList": true,
"geoLocationMethod": "TOOL",
"firstFloorHeight": 0.1,
"firstFloorHeightMethod": "EC",
"firstFloorHeightMethodDate": "2019-08-24",
"leasedFederalProperty": true,
"leveeQuality": "string",
"numPriorClaims": 0,
"pcwVersionNumber": "string",
"rcvDate": "2019-08-24",
"rcvDeterminationReason": "string",
"rcvFema": 0,
"rcvIndustry": 0,
"rcvMethod": "DATASET",
"section1316Property": true,
"severeRepetitiveLoss": true,
"statutoryDiscountType": "AR_FLOOD_ZONE_DISCOUNT_FACTOR",
"statutoryPremiumIncreaseCap": "NEWLY_MAPPED_FACTOR"
},
"riskRatingMethod": "6"
}
}
}

Create a quick flood quote (Beta)

Authorizations:

bearer

header Parameters

X-Client-Key

required

string

Client key

Request Body schema: application/json

buildingDeductible required	integer <int32> (buildingDeductible) Enum: 0 1000 1250 1500 2000 5000 10000 25000 50000 Building coverage deductible
contentsDeductible required	integer <int32> (contentsDeductible) Enum: 0 1000 1250 1500 2000 5000 10000 25000 50000 Contents coverage deductible
totalCoverageBuilding required	integer <int32> (totalCoverageBuilding) Building coverage maximums are as follows: Single-Family Home - $250,000, Residential Manufactured/Mobile Home - $250,000, Residential Condominium Unit (in Residential Building) - $250,000, All Other Building Descriptions - None, Two-to-Four Family Building - $250,000, Other Residential Building - $500,000, Residential Condominium Building - Not to exceed the lesser of the building's replacement cost or total number of units X $250,000, Non-Residential Building - $500,000, Non-Residential Manufactured/Mobile Building - $500,000, Non-Residential Unit - None.
totalCoverageContents required	integer <int32> (totalCoverageContents) Contents covergage maximums are as follows: Single-Family Home - $100,000, Residential Manufactured/Mobile Home - $100,000, Residential Condominium Unit (in Residential Building) - $100,000, All Other Building Descriptions - $100,000, Two-to-Four Family Building - $100,000, Other Residential Building - $100,000, Residential Condominium Building - $100,000, Non-Residential Building - $500,000, Non-Residential Manufactured/Mobile Building - $500,000, Non-Residential Unit - $500,000.
effectiveDate required	string <date>
	object
newRolloverTransferType	string (newRolloverTransferType) Enum: "N" "R" "E" "Z" "T" "O" Code that indicates the type of new business being reported by the WYO. Default is N. N:New Issue; R:Rollover; E:(Canceled effective May 1, 2005); Z: Rewritten for TRRP cancellation reason codes 03, 22, 24, 25; T: Transfer; O: RiskRating2.0 Opt-In option Only available until March 31, 2022
addressLine1 required	string
adddressLine2	string
city required	string
state required	string
zipCode required	string
zipPlus4	string
	object
buildingDescription required	string (buildingDescription) Enum: "MAINHOUSEBLDG" "DETACHEDGUESTHOUSE" "DETACHEDGARAGE" "AGRICULTURALBLDG" "COMMERCIAL" "RECREATIONBLDG" "TOOLSTORAGESHED" "OTHER" "ENTIRECOOPERATIVEBLDG" "ENTIREAPARTMENTBLDG" "COOPERATIVEUNIT" "APARTMENTUNIT" "RESIDENTIALCONDOUNITRB" "RESIDENTIALCONDOUNITNRB" "ENTIRERESCONDOBLDG" "OTHERNONRESIDENTIAL" "GOVOWNED" "HOUSEOFWORSHIP" Indicates the description of use of the insured building. MAINHOUSEBLDG: Main House/Building; DETACHEDGUESTHOUSE: Detached Guest House; DETACHEDGARAGE: Detached Garage; AGRICULTURALBLDG: Agricultural Building; COMMERCIAL: Commercial; RECREATIONBLDG: Recreation Building; TOOLSTORAGESHED: Tool/Storage Shed; OTHER: Other; ENTIRECOOPERATIVEBLDG: Entire Cooperative Building; ENTIREAPARTMENTBLDG: Entire Apartment Building; COOPERATIVEUNIT: Cooperative Unit; APARTMENTUNIT: Apartment Uni;, RESIDENTIALCONDOUNITRB: Residential Condo Unit - Residential Building; RESIDENTIALCONDOUNITNRB: Residential Condo Unit - Non-Residential Building; ENTIRERESCONDOBLDG: Entire Residential Condominium Building; OTHERNONRESIDENTIAL: Other Non-Residential Type; GOVOWNED: Government Owned; HOUSEOFWORSHIP: House of Worship
constructionType	string (constructionType) Enum: "FRAME" "MASONRY" "OTHER" Indicated construction type. FRAME: Frame; MASONRY: Masonry; OTHER: Other
foundationType required	string (foundationType) Enum: "SLABONGRADE" "ELEVATEDONCRAWLSPACE" "BASEMENT" "ELEVATEDWITHOUTENCLOSURE" "ELEVATEDWITHENCLOSURE" "ELEVATEDWITHENCLOSURENOTPPP" Indicates the foundation type of the property. SLABONGRADE: Slab on Grade (non-elevated); ELEVATEDONCRAWLSPACE: Crawlspace (includes subgrade); BASEMENT: Basement; ELEVATEDWITHOUTENCLOSURE: Elevated without enclosure on piers, posts & piles; ELEVATEDWITHENCLOSURE: Elevated with enclosure on piers, posts & piles; ELEVATEDWITHENCLOSURENOTPPP: Elevated with enclosure not on piers, posts & piles
numberOfFloors	integer <int32>
totalSquareFootage	integer <int32>
enclosureSize	integer or null <int32>
numberOfUnits	integer <int32>
occupancyType required	string (occupancyType) Enum: "SINGLEFAMILY" "TWOFOURFAMILY" "OTHERRESIDENTIAL" "RESIDENTIALUNIT" "RESIDENTIALCONDOBUILD" "NONRESIDENTIALUNIT" "NONRESIDENTIALBUILD" "RESIDENTIALMOBILEHOME" "NONRESIDENTIALMOBILEHOME" Code indicating the use and Risk Rated occupancy type of the insured structure. SINGLEFAMILY: Single Family; TWOFOURFAMILY: Two To Four Family Building; OTHERRESIDENTIAL :Other Residentail Building; RESIDENTIALUNIT:Residential Unit; RESIDENTIALCONDOBUILD: Residential Condo Building; NONRESIDENTIALUNIT: Non-Residential Unit; NONRESIDENTIALBUILD: Non-Residential Building; RESIDENTIALMOBILEHOME: Residential Mobile/Manufactured Home; NONRESIDENTIALMOBILEHOME: Non-Residential Mobile/Manufactured Home
primaryResidence required	boolean
floorOfUnit	integer <int32>
ecDate	string <date>
ecDiagramNumber	string
topBottomFloor	string
lowestAdjacentGrade	string
topHigherFloor	string
priorNaicNumber	string
priorPolicyNumber	string
industryReplacementCost	integer <int32>
buildingOverWaterType required	string (buildingOverWaterType) Enum: "NOTOVERWATER" "FULLOVERWATER" "PARTIALLYOVERWATER" This is the type code that determines if the insured building is not over water, partially over water, or fully/entirely over water. NOTOVERWATER: Not over Water; PARTIALLYOVERWATER: Partially over Water; FULLOVERWATER: Fully/Entirely over Water
isPropertyRental required	boolean
isUnderConstruction required	boolean
primaryFirstName	string
primaryLastName required	string Last name of the primary insured. Can also be organization name.
phoneNumber required	string
email	string
isInsuredOwner required	boolean
noOfElevators	integer <int32>
waitingPeriod	string (waitingPeriod) Enum: "STANDARD30" "LENDER30" "LOANNOWAIT" "MAPREVONEDAY" "ROLLOVER_RENEWAL" Waiting period for policy
applicantType	string (applicantType) Enum: "INDIVIDUAL" "BUSINESS" "ASSOCIATION" Applicant Type
isInsuredNonProfitEntity	boolean (isInsuredNonProfitEntity) Is the Policyholder/Member a non-profit entity
isInsuredHasSmallBusiness	boolean (isInsuredHasSmallBusiness) Is the Policyholder/Member a small business with less than 100 employees?
condoOwnership	boolean (condoOwnership) Is the policyholder/Member a condominium association?
priorLoanClosingDate	string <date>
priorPolicyExpiryDate	string <date>
priorNewBusinessDate	string <date>
isMobileHome	boolean (isMobileHome) Is the Structure a Mobile Home?
datetOfConstructionSource	string (datetOfConstructionSource) Enum: "LOCATEDIN" "LOCATEDOUTSIDE" This is the type code that determines if Located In a Mobile Home Park (LOCATEDIN) or Subdivision or Located Outside a Mobile Home Park or Subdivision (LOCATEDOUTSIDE)
originalConstructionDate required	string <date> Construction Date / Date The Park/subdivision was established if Located In a Mobile Home Park or Subdivision / Date of Permanent Placement
substantialImprovement	boolean (substantialImprovement) Has the building been substantially improved?
isBuildingListedInNRHP	boolean (isBuildingListedInNRHP) Is building listed in the National Register of Historic Places?
substantialImprovementDate	string <date> Date of substantial improvement if building is not listed in the National Register of Historic place.
isBuildingTravelTrailer	boolean (isBuildingTravelTrailer) If Residential Mobile/Manufactured Home then If the building is a travel trailer, have the wheels and tires been removed?
homeAnchoredMethod	string (homeAnchoredMethod) Enum: "NOTANCHORED" "MANUFACTURESPECIFICATION" "MANAGMENTSPECIFICATION" "TIESTOGROUNDANCHORED" if Residential Mobile/Manufactured Home then How is the home anchored?. NOTANCHORED:Not Anchored; MANUFACTURESPECIFICATION:In Accordance with Manufacture's Specification; MANAGMENTSPECIFICATION:In Accordance with Community Floodplain Management Specification; TIESTOGROUNDANCHORED:Over-the-top or Frame Ties to Ground Anchored
serialNo	string If Residential Mobile/Manufactured Home then Serial
isPermanentFoundation	boolean (isPermanentFoundation) If Non-Residential Mobile/Manufactured Home then Is On Permanent foundation?
noOfDetatchedStructure	integer <int32> Number Of Detached Structures.
isBuildingContainME	boolean (isBuildingContainME) Does the building contain Machinery and equipment that services the building?
allMachinaryElevated	boolean (allMachinaryElevated) Is all machinery Elevated to the height of the floor above the basement or higher?
isValidElevationCertificate	boolean (isValidElevationCertificate) Do you have a valid elevation certificate?
isNewPurchase	boolean (isNewPurchase) Is this a new purchase (within the last year)?
isSellerDec	boolean (isSellerDec) Do you have sellers policy information?
isPriorNFIPPolicy	boolean (isPriorNFIPPolicy) Has the applicant had a prior NFIP policy for this structure?
isPriorNFIPLapsed	boolean (isPriorNFIPLapsed) Did the prior policy lapse while receiving a pre-firm discount?
isCommunityLapseSuspension	boolean (isCommunityLapseSuspension) Was the lapse the result of a community suspension?
hasProperFloodOpenings	boolean Does the enclosure have proper openings?
numberOfFloodOpenings	integer <int32> Number of openings
totalAreaFloodOpenings	integer <int32> Total square inches of Open Area
wereEngineeredVentsused	boolean Were engineered vents used?
quoteSourceCode	string A value can be passed in this field that can be used for reporting in the Taurus system. Example would include a special project where you need to track the success of the quote to policy conversion ratio

Responses

Request samples

Payload

Content type

application/json

{"buildingDeductible": 5000,
"contentsDeductible": 5000,
"totalCoverageBuilding": 250000,
"totalCoverageContents": 20000,
"effectiveDate": "2023-10-25",
"agentOverrideInfo": {"agencyWyoCode": "",
"agentWyoCode": "",
"agentFloodCode": ""
},
"newRolloverTransferType": "N",
"addressLine1": "11515 Dutch Iris Dr",
"addressLine2": "",
"city": "Riverview",
"state": "FL",
"zipCode": "33578",
"zipPlus4": "",
"userSuppliedGeoLocation": {"latitude": 0,
"longitude": 0
},
"isMobileHome": false,
"buildingDescription": "MAINHOUSEBLDG",
"constructionType": "FRAME",
"foundationType": "ELEVATEDWITHENCLOSURE",
"numberOfFloors": 3,
"totalSquareFootage": 2500,
"numberOfUnits": 1,
"occupancyType": "SINGLEFAMILY",
"primaryResidence": true,
"floorOfUnit": 1,
"industryReplacementCost": 650000,
"buildingOverWaterType": "NOTOVERWATER",
"isPropertyRental": true,
"isUnderConstruction": false,
"primaryFirstName": "John",
"primaryLastName": "Doe",
"phoneNumber": "5555555555",
"email": "test@test.com",
"isInsuredOwner": true,
"noOfElevators": 2,
"waitingPeriod": "STANDARD30",
"applicantType": "INDIVIDUAL",
"isInsuredNonProfitEntity": false,
"isInsuredHasSmallBusiness": false,
"condoOwnership": false,
"PriorLoanClosingDate": "2019-03-01",
"priorPolicyExpiryDate": "2020-04-01",
"priorPolicyNumber": "",
"priorNaicNumber": "15826",
"priorNewBusinessDate": "2020-04-01",
"datetOfConstructionSource": "LOCATEDIN",
"originalConstructionDate": "1985-01-01",
"substantialImprovement": true,
"isBuildingListedInNRHP": false,
"substantialImprovementDate": "2021-02-01",
"isBuildingTravelTailer": true,
"homeAnchoredMethod": "MANUFACTURESPECIFICATION",
"serialNo": "12abc",
"isPermanentFoundation": false,
"noOfDetatchedStructure": 2,
"isBuildingContainME": false,
"allMachinaryElevated": false,
"isValidElevationCertificate": false,
"isNewPurchase": true,
"isSellerDec": true,
"isPriorNFIPPolicy": false,
"isPriorNFIPLapsed": false,
"isCommunityLapseSuspension": false,
"enclosureSize": 1500,
"ecDate": "2004-06-02",
"ecDiagramNumber": "1A",
"topBottomFloor": "5",
"lowestAdjacentGrade": "7",
"topHigherFloor": "2",
"hasProperFloodOpenings": false,
"numberOfFloodOpenings": 0,
"totalAreaFloodOpenings": 0,
"wereEngineeredVentsused": false,
"quoteSourceCode": ""
}

Response samples

Content type

application/json

{"status": true,
"data": {"quoteNumber": "string",
"quoteURL": "string",
"transactionDate": "string",
"transactionId": "string",
"code": 0,
"message": "string",
"fieldErrors": [ ],
"ruleFailures": [ ],
"policyQuoteDetails": {"uuid": "string",
"coverageAmounts": [{"coverageAmountType": "CURRENT_COVERAGE",
"buildingDeductible": 0,
"contentsDeductible": 0,
"industryReplacementCost": 0,
"totalCoverageBuilding": 0,
"totalCoverageContents": 0
}
],
"effectiveDate": "2019-08-24",
"endorsementEffectiveDate": "string",
"naicNumber": "string",
"newRolloverTransferType": "N",
"policyAssignmentType": "string",
"policyNumber": "string",
"premium": {"annualIncreaseCapDiscount": 0,
"buildingPremium": 0,
"contentsPremium": 0,
"crsDiscount": 0,
"discountedPremium": 0,
"federalPolicyFee": 0,
"fullRiskPremium": 0,
"hfiaaSurcharge": 0,
"iccPremium": 0,
"mitigationDiscounts": 0,
"newlyMappedDiscount": 0,
"otherStatutoryDiscounts": 0,
"preFirmDiscount": 0,
"probationSurcharge": 0,
"reserveFundAssessment": 0,
"totalAnnualPayment": 0,
"totalCalculatedPremium": 0,
"discountedBuildingPremium": 0,
"discountedContentsPremium": 0
},
"proratedPremium": null,
"priorNaicNumber": "string",
"priorPolicyNumber": "string",
"propertyAddress": {"addressLine1": "string",
"addressLine2": "string",
"addressType": "CLEAR",
"city": "string",
"countyFips": "string",
"deleteAddress": true,
"floodZone": "A",
"id": 0,
"nameOrDescriptiveType": "string",
"propertyBeginningStreetNumber": 0,
"state": "string",
"stateFips": "string",
"zipCode": "string",
"zipPlus4": "string"
},
"propertyCharacteristics": {"constructionDetails": {"buildingDescription": "MAINHOUSEBLDG",
"buildingOverWaterType": "NOTOVERWATER",
"constructionType": "FRAME",
"enclosureSize": 0,
"floodProofed": true,
"foundationType": "SLABONGRADE",
"hasProperFloodOpenings": true,
"numberOfFloodOpenings": 0,
"numberOfFloors": 0,
"originalConstructionDate": "2019-08-24",
"substantialImprovementDate": "string",
"totalAreaFloodOpenings": 0,
"totalSquareFootage": 0,
"buildingUnderConstruction": true
},
"elevationCertificate": "string",
"floorOfUnit": 0,
"industryGeoDetails": {"communityNumber": "string",
"currentMapDate": "string",
"emergencyProgram": true,
"floodZone": "A",
"initialFirmDate": "2019-08-24",
"latitude": 0.1,
"longitude": 0.1,
"cbrsBufferZoneDetermination": true,
"cbrsOpaBuildingConsistentUse": true
},
"machineryOrEquipmentAbove": true,
"newlyMapped": true,
"newlyMappedDiscountEligible": true,
"numberOfUnits": 0,
"occupancyType": "SINGLEFAMILY",
"postFirmConstruction": true,
"preFirmSubsidyEligible": true,
"primaryResidence": true
},
"quoteSubmittedLocalDateTime": "string",
"quoteTransactionType": "ENDORSEMENT_QUOTE",
"quoteFactors": {"cbrsSystemUnitOrOpa": "string",
"cbrsSystemUnitOrOpaYear": "string",
"crsClass": 0,
"crsExclusionList": true,
"geoLocationMethod": "TOOL",
"firstFloorHeight": 0.1,
"firstFloorHeightMethod": "EC",
"firstFloorHeightMethodDate": "2019-08-24",
"leasedFederalProperty": true,
"leveeQuality": "string",
"numPriorClaims": 0,
"pcwVersionNumber": "string",
"rcvDate": "2019-08-24",
"rcvDeterminationReason": "string",
"rcvFema": 0,
"rcvIndustry": 0,
"rcvMethod": "DATASET",
"section1316Property": true,
"severeRepetitiveLoss": true,
"statutoryDiscountType": "AR_FLOOD_ZONE_DISCOUNT_FACTOR",
"statutoryPremiumIncreaseCap": "NEWLY_MAPPED_FACTOR"
},
"riskRatingMethod": "6"
}
}
}

Get private product flood quote

Authorizations:

bearer

header Parameters

X-Client-Key

required

string

Client key

Request Body schema: application/json

NFIPQuoteNumber required	string Existing NFIP quote number
productType required	string (productType) Enum: "ezflood" "AonEdgeExcess" "macneill" "neptune" "cat" Private Product Name

Responses

Request samples

Payload

Content type

application/json

{"NFIPQuoteNumber": "TMP240318989175",
"productType": "neptune"
}

Response samples

Content type

application/json

{"status": true,
"data": {"NFIPQuoteNumber": "string",
"policyQuoteDetails": {"quoteNumber": "string",
"buildingCoverage": 0,
"contentsCoverage": 0,
"deductible": 0,
"quoteLink": "string",
"premium": null
}
}
}

Create agency

Authorizations:

bearer

header Parameters

X-Client-Key

required

string

Client key

Request Body schema: application/json

agencyName required	string
corpStatus required	boolean (corpStatus) Agency CORP Status
FEINNumber required	string
taxType required	string (taxType) Enum: "FEIN" "SS" Agency Tax Type
brandedCompany	string
settlementCode	string
required	object (agencyAddress)
	object (agencyAddress)
phone required	string
fax required	string
managerPhone	string
managerEmail	string
principlePhone	string
principleEmail	string
	object (agencyAddress)
	object (agencyCommission)

Responses

Request samples

Payload

Content type

application/json

{"agencyName": "TEST AGENCY",
"corpStatus": true,
"FEINNumber": "123456789",
"taxType": "FEIN",
"mailingAddress": {"addressLine1": "1101 E Cumberland Ave.",
"addressLine2": "Suite 300",
"zip": "33602",
"city": "Tampa",
"state": "FL"
},
"phone": "1234567890",
"fax": "1234567890"
}

Response samples

Content type

application/json

{"status": true,
"data": {"message": "string",
"fieldErrors": [ ]
}
}

Policy/Claim Search For External

Authorizations:

bearer

header Parameters

x-api-key

required

string

Client Api Key

Request Body schema: application/json

type required	string Enum: "policy" "claim" Search Type
referenceNo required	string ReferenceNo Number

Responses

Request samples

Payload

Content type

application/json

{"type": "policy",
"referenceNo": "FLD3139000323"
}

Response samples

Content type

application/json

{"status": true,
"TotalCount": 0,
"data": [{"_id": "string",
"policy_no": "string",
"tenancy": "string",
"agency": "string",
"effective_date": "2019-08-24",
"policy_status": "APPLICATION",
"full_name": "string",
"identifier": "string"
}
]
}