Tags were added in the Defined Data release to identify the specific use of a placeholder
There will be a tag starting 'Page:' which is used to relate tags, for instance the lines of a table, or the terms of a section, or where there are multiple periods applying to the risk.
There will also be one or more tags indicating the purpose of the defined data item - 'Insured_Name', 'Inception_Date', 'Premium_Amount' and so on. Multiple tags of this sort indicate that the same value applies. 'Inception_Time' and 'Expiry_Time', for instance, are often the same value. items: type: string example: Premium_Amount responses: '200': description: successful response content: application/json: schema: $ref: '#/components/schemas/RWPlacing' example: provenance: dataHash: 0aafa0694cc205cd9f6c6c214f2fa60290aec52a25a16298d4401979d25a6e34 userID: MU9FCFC64E-7694-420A-BE61-2ABEDB3E8F52 provHash: a0364567216c7041bcda197d50a49504ad4b75098c05e2c4bf8452f3e1e4f46f system: LaVAPI writtenAt: '2023-09-22 13:20:38' version: 2023-09-21@19:07:10 updatedAt: '2023-09-22 13:20:38' createdAt: '2023-05-05 11:38:23' type: RWPlacing _rev: 2-469f0a5e1c1817de973f7c84430f49eb control: insuredName: Acme Widgets Inc umr: B123123123123 placementType: FullContract createdInVersion: 21100 originalDocID: '' placingBrokerChannel: akhil_ALL isFacility: false status: NotFinalised insuranceType: Insurance placingBroker: AKHIL All Risks shownToUnderwriter: '' limitSummary: USD 100,000,000 contractType: Cyber Insurance proposedEndorsementFollowers: {} channels: - akhil_ALL _id: IC97799647-4496-4760-B594-02AC726B0D7E accountDocID: null MRCContract: lineItems: - fragments: [] originalHeading: 'RISK DETAILS ' nameVariation: NonMRCHeading mrcSection: RiskDetails placeholders: [] elements: [] originalSection: self index: 0 subItems: [] mrcHeading: NonMRCHeading - subItems: [] originalHeading: UMR elements: - index: 0 text: B123123123123 mrcHeading: UMR fragments: [] originalSection: '' nameVariation: UMR placeholders: [] mrcSection: RiskDetails index: 1 - nameVariation: Company originalHeading: COMPANY subItems: [] elements: - index: 0 text: Swagger Simple Save Example mrcHeading: Insured locked: false fragments: [] originalSection: '' placeholders: [] tagPages: - title: '' sectionIDs: [] pageID: 9763BF50-3F8A-40B2-A2A8-6C20E709B2DB index: 2 mrcSection: RiskDetails - subItems: [] originalHeading: ADDRESS elements: - index: 0 text: 11 Amelia Earhart Way, Rongotai, Wellington 6003, New Zealand mrcHeading: PrincipalAddress fragments: [] nameVariation: Address placeholders: [] originalSection: '' mrcSection: RiskDetails index: 3 - mrcHeading: Period originalHeading: PERIOD nameVariation: Period locked: false mrcSection: RiskDetails placeholders: - value: 31 August 2021 originalValue: 31 August 2021 name: DefinedData0 phType: Date tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Inception_Date - value: 31 August 2022 originalValue: 31 August 2022 name: DefinedData1 phType: Date tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Expiry_Date - value: 12.01 a.m. originalValue: 12.01 a.m. name: DefinedData2 phType: DefinedData tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Inception_Time - Expiry_Time - value: Local Standard Time originalValue: Local Standard Time name: DefinedData3 phType: DefinedData tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Time_Qualifier index: 4 elements: - index: 0 text: 'From: [[DefinedData0]]' - index: 1 text: 'To: [[DefinedData1]]' - index: 2 text: Both days at [[DefinedData2]] [[DefinedData3]] at the location of the property insured. originalSection: '' subItems: [] tagPages: - title: '' sectionIDs: [] pageID: 17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 fragments: [] - originalHeading: TYPE mrcHeading: ContractType nameVariation: ContractType mrcSection: RiskDetails placeholders: [] index: 5 elements: - index: 0 text: Aviation Hull and Liability Insurance originalSection: '' subItems: [] fragments: [] - mrcHeading: LimitOfLiability fragments: [] nameVariation: LimitsOfLiability locked: false mrcSection: RiskDetails placeholders: - value: USD 100,000,000 originalValue: USD 100,000,000 name: Amount1 phType: Amount elements: - index: 0 text: '[[Amount1]] each and every loss sdfsdf' index: 6 tagPages: - title: '' sectionIDs: [] pageID: 0EA4F5E0-05D5-4B74-B5B0-2CF56B0AD774 subItems: [] originalSection: '' originalHeading: LIMITS OF LIABILITY - originalHeading: PREMIUM fragments: [] nameVariation: Premium locked: false mrcSection: RiskDetails placeholders: - value: 100% originalValue: 100% name: Percentage1 phType: Percentage - value: USD 5,500,000 originalValue: USD 5,500,000 name: DefinedData0 phType: Amount tags: - Page:6A45CE72-A1D1-4270-B767-0DDAF5FF0735 - Premium_Amount - value: annual originalValue: annual name: DefinedData1 phType: DefinedData tags: - Page:6A45CE72-A1D1-4270-B767-0DDAF5FF0735 - Premium_Period_Qualifier elements: - index: 0 text: ' [[DefinedData0]] ([[Percentage1]]) [[DefinedData1]]' tagPages: - pageID: 6A45CE72-A1D1-4270-B767-0DDAF5FF0735 sectionIDs: [] title: '' originalSection: '' subItems: [] index: 7 mrcHeading: Premium - fragments: [] originalHeading: 'INFORMATION ' nameVariation: NonMRCHeading mrcSection: Information placeholders: [] elements: [] originalSection: self index: 8 subItems: [] mrcHeading: NonMRCHeading - originalHeading: INFORMATION mrcHeading: Information nameVariation: Information locked: false mrcSection: Information placeholders: [] elements: - index: 0 text: '' index: 9 tagPages: - pageID: F479C70D-2059-417F-98F6-64F9F041BD37 sectionIDs: [] title: '' subItems: [] originalSection: '' fragments: [] - fragments: [] mrcHeading: NonMRCHeading nameVariation: NonMRCHeading mrcSection: SecurityDetails placeholders: [] index: 15 originalSection: self elements: [] subItems: [] originalHeading: 'SECURITY DETAILS ' - originalHeading: WRITTEN LINES mrcHeading: InsurersWrittenLine nameVariation: InsurersWrittenLine mrcSection: SecurityDetails placeholders: [] index: 16 originalSection: '' elements: - index: 0 text: In a co-insurance placement, following (re)insurers may, but are not obliged to, follow the premium charged by the lead (re)insurer. - index: 1 text: (Re)insurers may not seek to guarantee for themselves terms as favourable as those which others subsequently achieve during the placement. subItems: [] fragments: [] - originalHeading: 'SUBSCRIPTION AGREEMENT ' fragments: [] nameVariation: NonMRCHeading mrcSection: SubscriptionAgreement placeholders: [] index: 10 originalSection: self elements: [] subItems: [] mrcHeading: NonMRCHeading - fragments: [] mrcHeading: SlipLeader nameVariation: SlipLeader mrcSection: SubscriptionAgreement placeholders: [] index: 11 originalSection: '' elements: - index: 0 text: The Slip Leader is ENTER SLIP LEADER subItems: [] originalHeading: SLIP LEADER - originalHeading: BUREAU(X) LEADER(S) fragments: [] nameVariation: BureauLeader mrcSection: SubscriptionAgreement placeholders: [] index: 12 originalSection: '' elements: - index: 0 text: The Bureau(x) Leader(s) (where applicable) is AAA NNN subItems: [] mrcHeading: BureauLeader - fragments: [] originalHeading: 'FISCAL AND REGULATORY ' nameVariation: NonMRCHeading mrcSection: FiscalAndRegulatory placeholders: [] elements: [] index: 13 originalSection: self subItems: [] mrcHeading: NonMRCHeading - fragments: [] mrcHeading: NonMRCHeading nameVariation: NonMRCHeading mrcSection: BrokerRemunerationAndDeductions placeholders: [] index: 14 originalSection: self elements: [] subItems: [] originalHeading: 'BROKER REMUNERATION AND DEDUCTIONS ' '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/editMultipleLineItems: post: tags: - Risks summary: Edits multiple line items at the same time on a risk parameters: - in: path name: riskID required: true schema: type: string description: The unique ID of the risk, starting IC and having parts delimited by '::' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: description: Data specifying the line item(s) update required: true content: application/json: example: _rev: 3-4b7396eecc00408efcdb43c5f8dd147d items: - op: edit _rev: 3-4b7396eecc00408efcdb43c5f8dd147d index: 3 elements: - text: '[[DefinedData0]] and all subsidiaries' index: 0 placeholders: - name: DefinedData0 value: Acme Widgets Inc phType: DefinedData tags: - Page:3AB5B151-2F0A-4496-B5FB-08A6DCEE5F56 - Insured_Name tagPages: - pageID: 3AB5B151-2F0A-4496-B5FB-08A6DCEE5F56 title: '' sectionIDs: [] attributes: locked: false - op: edit _rev: 3-4b7396eecc00408efcdb43c5f8dd147d index: 4 elements: - text: '[[DefinedData0]]' index: 0 - text: '[[DefinedData1]] [[DefinedData2]]' index: 1 - text: '[[DefinedData3]]' index: 2 placeholders: - name: DefinedData0 value: 22 Bishopsgate phType: DefinedData tags: - Page:787951F4-4B03-48B5-86CB-9D1A65B3ED26 - Insured_Number_And_Street - name: DefinedData1 value: London phType: DefinedData tags: - Page:787951F4-4B03-48B5-86CB-9D1A65B3ED26 - Insured_City_Name - name: DefinedData2 value: EC2M 2XX phType: DefinedData tags: - Page:787951F4-4B03-48B5-86CB-9D1A65B3ED26 - Insured_Postal_Code - name: DefinedData3 value: United Kingdom phType: DefinedData tags: - Page:787951F4-4B03-48B5-86CB-9D1A65B3ED26 - Insured_Country tagPages: - pageID: 787951F4-4B03-48B5-86CB-9D1A65B3ED26 title: '' sectionIDs: [] attributes: locked: false - op: edit _rev: 3-4b7396eecc00408efcdb43c5f8dd147d index: 12 elements: - text: '[[DefinedData1]] to [[DefinedData0]]' index: 0 placeholders: - name: DefinedData1 value: 1 January 2024 phType: Date tags: - Page:C53CE6F8-F349-4AB8-8F80-2C6E08CDA0BA - Inception_Date - name: DefinedData0 value: 31 December 2024 phType: Date tags: - Page:C53CE6F8-F349-4AB8-8F80-2C6E08CDA0BA - Expiry_Date tagPages: - pageID: C53CE6F8-F349-4AB8-8F80-2C6E08CDA0BA title: '' sectionIDs: [] attributes: locked: false schema: properties: rev: type: string description: the revision of the risk document example: 3-7984cfdf73dfca82ccd1178ec066b005 items: type: array items: properties: op: type: string description: requited to be 'edit' example: edit index: type: number description: the index of the line item to be changed example: 6 attributes: type: object properties: locked: type: boolean description: true if the item is to be locked, ie not editable by the underwriter example: false elements: type: array description: a set of elements containing the textual detail of the line item items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/elements/items' tagPages: type: array description: tag pages used for Defined Data, which is optional and can be empty items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/tagPages/items' placeholders: type: array description: a set of placeholders for data values picked out for the line item items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/placeholders/items' responses: '200': description: successful response content: application/json: schema: $ref: '#/components/schemas/RWPlacing' /api/risks/{riskID}/changeDraftNowQuoteInPreparation: post: summary: The Underwriter takes a Quotation Request and starts preparing an Underwriter Quotation - Underwriter Only description: No payload is required for this endpoint tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and expected to end ::QRx where x is 1, 2, 3 etc example: IC8F2D09C8-A220-4DD6-9E14-77AFF7A617AC::QR2 responses: '200': description: successful response content: application/json: schema: type: object properties: newDocID: type: string description: the doc ID of the created Underwriter Quotation example: IC8F2D09C8-A220-4DD6-9E14-77AFF7A617AC::MU71BA6F2F-FFD1-4A92-86AC-5277FEAF3012::UQ4 /api/risks/{riskID}/cloneDraft: post: summary: Clones an existing risk as a new draft, setting UMR and Insured - Broker Only tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description:
The unique ID of the risk, starting with IC and having parts delimited by '::'. NEW in release 2.20 - If a template is in multiple teams, the channel field is mandatory in order to choose which team a risk is cloned to. Please make sure to use a channel that the template is in, otherwise it will return an error. example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: content: application/json: schema: type: object required: - umr - insuredName properties: umr: type: string description: The UMR of the new risk. example: B0999JC3011211103 placementType: type: string description: 'The type of contract to create: FullContract or Template or OffPlatform. If not specified, will be the same as the source risk.' example: FullContract insuredName: type: string description: The insured or reinsured for display within the Platform. example: Acme Widgets Inc channel: type: string description: the channel of team you want to clone to. Mandatory IF template is in multiple teams. example: blackpool_MARINE contractFontSize: type: string description: the font size you want the risk to have. enum: - 10pt - 11pt - 12pt - 14pt - 15pt - 16pt - 18pt - 20pt contractDateFormat: type: string description: choose whether you want the date to be in GB or US format. enum: - en-GB - en-US description: 'CloneDraftInput object. Optional item(s): placementType, contractFontSize, contractDateFormat, channel.' responses: '200': description: successful response content: application/json: schema: type: object properties: msg: type: string description: message describing success example: Draft clone created. id: type: string description: The unique ID of the new risk, starting with IC. As it is a Draft, it will not have any '::' delimiters. example: ICF9074CE2-4D25-4ECB-AE5D-27CEA1A25F9B /api/risks/{riskID}/declineQuoteRequest: post: summary: Called by the Underwriter to decline a quote request - Underwriter Only tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and expected to end ::QRx where x is 1, 2, 3 etc example: IC8F2D09C8-A220-4DD6-9E14-77AFF7A617AC::QR2 requestBody: description: As of 3.3, we have introduced reasons for declining when declining quote requests required: false content: application/json: schema: type: object properties: reasons: type: array items: type: string description: The reason(s) for declining example: CannotMeetSpecificationOrFormRequests enums: - AttachmentPointTooLow - AuthorisedToAnotherBroker - CannotMeetSpecificationOrFormRequests - CatExposurePmlsTooHigh - DeductiblesTooLow - EngineeringRequirementsNotMet - InadequateTimeToQuote - InsufficientUnderwritingInformation - LackOfCapacity - LocationsOfRisk - LossHistory - NoAppetiteForThisClassOfBusiness - NotAcceptableToReinsuranceTreaty - OccupancyConcentration - OccupancyEnvironmentalFactors - OccupancyType - PremiumInsufficientForRisk - ReInsuredsFinancials - Other notes: type: string description: any additonal notes you want to provide example: Test note otherReason: type: string description: only if 'Other' was chosen as one of the reasons example: Test Reason responses: '200': description: successful response content: application/json: schema: type: object properties: msg: type: string description: a message showing that the quote has been declined example: Quote Request IC8F2D09C8-A220-4DD6-9E14-77AFF7A617AC::QR2 successfully declined /api/risks/{riskID}/draftToFirmOrder: post: summary: Creates a firm order risk from a draft - Broker Only description: No payload is required for this endpoint tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and stopping before any '::' delimiters example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854 requestBody: description: Please add an empty payload of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: successful response content: application/json: schema: type: object properties: msg: type: string example: doc with id IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854 successfully marked as firm order description: A message indicating success /api/risks/{riskID}/endorsementFollowers: get: summary: Details of the follower carriers on an endorsement tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the endorsement example: IC4E49E958-870A-41B3-B60B-B5AAC51F48A5::SIGNED::EN1 responses: '200': description: array of RwEndorsementFollower objects content: application/json: schema: type: array items: $ref: '#/components/schemas/RWEndorsementFollower' /api/risks/{riskID}/getExtendedMRC: get: tags: - Risks summary: get extended data about the state of a risk, adding, for instance, written and signed lines to the risk itself parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExtendedMRC' /api/risks/{riskID}/lineitem/{mrcHeading}: get: summary: Gets the line item by index, or all line items for a specified heading description: The final parameter can be a numeric index, or a specific heading such as Period, Premium etc.
The endpoint /api/lookup/headings gives list of the available headings. Note that the API returns an array as there could be more than one line item with the chosen heading. tags: - Risks parameters: - in: path name: riskID required: true schema: type: string description: The unique ID of the risk, starting IC and having parts delimited by '::' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO - in: path name: mrcHeading required: true schema: type: string description: Enumerated value for MRC Heading, or a numeric index example: ContractType responses: '200': description: array of MRCLineItem content: application/json: schema: type: array items: type: object description: The MRCLineItem object, often referred to as 'Line Item', comprises a single contract heading and its associated text and other data.Contract headings exist both as the visible heading title shown to the user, known as Original Heading, and as structural pointers in the database. The most important of these pointers are the mrcHeading which links the Line Item back to its purpose (Period, Insured etc) and the mrcSection which associates it with the contract section where it appears. An index controls the ordering. There is also a Name Variation which encapsulates certain agreed alternative terms for the heading, but this is less significant. properties: index: type: integer description: The ordinal position of the line item in the contract, starting from 1. Each index value should be a unique integer, and the values should be continuous across the contract example: 5 mrcSection: type: string description: The title of the contract section, taken from an enumerated list enum: - BrokerRemunerationAndDeductions - FiscalAndRegulatory - Information - RiskDetails - SecurityDetails - SubscriptionAgreement - Endorsement - ContractAdministrationAndAdvisory - EndorsementData - RiskAndEndorsementIdentificationDetails - ContractChanges - Agreement - PlacingData - Panel - CoverSheet - Disclaimers - Missing - Unknown example: RiskDetails mrcHeading: type: string description: The MRC-approved version of the original heading, taken from an enumerated list. Note that the endpoint /api/lookup/headings returns this list example: LimitOfLiability enum: - UMR - PolicyNumber - AttachingToLineslipContractOrBindingAuthorityAgreementNumber - ContractType - ProposalForm - Insured - OriginalInsured - Retrocedent - OriginalReinsured - Reinsured - PrincipalAddress - Period - OriginalPolicyPeriod - Conveyance - Vessels - Interest - AdditionalCoverages - LimitOfLiability - AggregateLimit - UnderlyingLimits - Excess - Sublimits - Deductibles - ReInsuredsRetention - ReinstatementProvisions - IndemnityPeriod - Exclusions - Situation - BasisOfValuation - Conditions - OriginalConditions - LossPayee - CoReinsuranceWarranty - Notices - ExpressWarranties - ConditionsPrecedent - Subjectivities - ChoiceOfLawAndJurisdiction - Arbitration - Premium - PremiumTransfer - PremiumPaymentTerms - Bordereaux - Commission - EstimatedPremiumIncome - TaxesPayableByInsuredAndAdministeredByInsurers - TaxesPayableByInsurersAndAdministeredByInsuredOrTheirAgent - ProfitCommission - RecordingTransmittingAndStoringInformation - InsurerContractDocumentation - Form - SlipPolicyNotice - PremiumReserveAndInterest - LossReserveAndInterest - CashLossLimit - Portfolio - PremiumPortfolio - LossPortfolio - Accounts - BasisOfLoss - PriorAndPendingLitigation - CountryOfInsured - EndorsementAgreements - UseToWhichInsuredPropertyIsPut - OccupationOfTheInsuredPersons - DisputeResolution - RetroactiveDate - InsurerDocumentProduction - ScopeOfInsurance - EstimatedPeriod - Information - ReinsurersLiability - OrderHereon - BasisOfWrittenLines - BasisOfSignedLines - SigningProvisions - SyndicatePseudonym - SyndicateIdNumber - CompanyName - CompanyIdNumber - UnderwriterReference1 - UnderwriterReference2 - InsurersWrittenLine - InsurersWrittenLineInUnits - InsurersWrittenLineInLines - LineConditions - SigningInstructions - InsurersSignedLine - ProvisionsSpecificToPanelSecurity - SlipLeader - BureauLeader - BasisOfAgreementToContractChanges - OtherAgreementPartiesForContractChangesForPart2GUAChangesOnly - AgreementPartiesForContractChangesForTheirProportionOnly - BasisOfClaimsAgreement - ClaimsAgreementParties - ClaimsAdministration - RulesAndExtentOfAnyOtherDelegatedClaimsAuthority - ExpertsFeesCollection - SettlementDueDate - InstalmentPremiumPeriodOfCredit - AdjustmentPremiumPeriodOfCredit - BureauxArrangements - NonBureauxArrangements - SingleClaimsAgreementPartyArrangements - TaxPayableByInsurers - CountryOfOrigin - OverseasBroker - SurplusLinesBroker - StateOfFiling - LicenseInformation - USClassification - NAICCodes - AllocationOfPremiumToCoding - AllocationOfPremiumToYearsOfAccount - FsaClientClassification - RegulatoryClientClassification - ForeignAccountTaxComplianceAct - IsTheBusinessSubjectToDistanceMarketingDirective - NoticeOfCancellationProvisions - WholesaleBroker - RetailBroker - FeePayableByClient - TotalBrokerage - RetailBrokerage - WholesaleBrokerage - OtherDeductionsFromPremium - CustomMRCHeading - NonMRCHeading - EndorsementName - EndorsementNumber - EndorsementReference - EndorsementEffectiveDate - ContractChanges - ParticipantChanges - PremiumProcessingType - LineSlipReference - BrokerName - BrokerAddress - AuthorisedClassesOfBusinessAndCoverages - ExclusionsWithinTheAuthorisedClassesOfBusinessAndCoverages - PeriodFromDate - PeriodToDate - ExtensionsOfPeriodOfLineSlip - MaximumPeriodOfEachInsuranceBound - MaximumLimitsOfLiability - MaximumAggregateLimits - TerritoriesFromWhichEachInsuranceMayBeBound - TerritorialLimitsOfEachInsuranceBound - ConditionsOfEachInsuranceBound - NoticesOfEachInsuranceBound - ExpressWarrantiesOfEachInsuranceBound - ConditionsPrecedentOfEachInsuranceBound - ChoiceOfLawAndJurisdictionOfTheLineSlip - ChoiceOfLawAndJurisdictionOfEachInsuranceBound - GrossPremiumIncomeLimit - NotifiablePercentageOfTheGrossPremiumIncomeLimitNotToExceed - PremiumBordereauxInterval - TaxesPayableByInsuredAndAdministeredByInsurersForEachInsuranceBound - CancellationNoticeOfTheLineSlip - AgreementPartiesForLineSlipChanges - BasisOfAgreementToLineSlipChanges - ScopeAndLimitsOfDelegationForLineSlipChanges - AgreementPartiesForEachInsuranceBoundAndAlterationsThereto - BasisOfAgreementForEachInsuranceBoundAndAlterationsThereto - ScopeAndLimitsOfDelegationForInsurancesBoundAndAlterationsThereto - LineSlipAdministration - PlacingData - ContractSections - ClaimsBasis - ClaimsExperts - FeesPayableToReInsurers - PremiumDiscountsCommissionsAndOrDeductionsPayableToThePolicyholder - ContractualExchangeRate - Policyholder - TaxesPayableAndAdministeredByTheReInsuredOrTheirAgent - ContractClause - ContractWording - GroupReference - ClaimsPaymentDate - Definitions - Financing - Tenor - PremiumSigning - IndustrialSectorCode - RegulatoryRiskLocation - SettlementDetails - CorrectionSummary - AgreementDetails - DeclinedReasons - RevokedCorrectionReason - AgencyInformation - CarrierInformation - LineOfBusiness - PolicyInformation - ApplicantInformation - Unknown nameVariation: type: string description: The valid mrcHeadings along with any standard anticipated variations -- such as 'GeographicalAreas' and 'TerritorialLimits' for 'Situation' -- taken from an enumerated list. The endpoint /api/lookup/namevariations returns this list example: Limit originalHeading: type: string description: The contract heading name as shown to the user example: Limit of Liability originalSection: type: string description: If the line item is a section heading, has the value 'self'. Left blank otherwise example: '' locked: type: boolean description: True if the broker has locked the line item to limit its editability example: false lockType: description: The type of locking applied to the line item. Blank when locked is false. type: string enum: - lockTextOnly - lockAll - lockTextOnlyTemplate - lockAllTemplate attachment: description: If the line item is an inline attachment, its data will be stored in this array type: object properties: docID: type: string example: IC5FF93255-74CA-4788-A668-0080992DAED9::ATCH::INLINE::IA-3EC366E1-DCC8-4EF3-B5F1-555EA57B7612 description: The unique ID of the attachment document in its place as part of a risk attachmentID: type: string example: IA-3EC366E1-DCC8-4EF3-B5F1-555EA57B7612 description: The unique ID of the attachment document without associated risk data; the last delimited section of docID attachmentName: type: string example: sov.xlsx description: The filename of the attachment appendixTitle: type: string example: Inline Attachment Title description: Contains the optional title, if any, added as a placeholder within the contract to identify the attachment when it is set to export after the contract. Blank if not provided or if prepend is TRUE appendixDescription: type: string example: Inline Attachment Example description: Contains the optional description text, if any, added below appendixTitle to describe the attachment when it is set to export after the contract. Blank if not provided or if prepend is TRUE prepend: type: boolean example: true description: True if the attachment has been set to appear at the front of the contract when exporting image: description: If the line item is an inline image, its data will be stored in this array. type: object properties: docID: type: string example: IC5FF93255-74CA-4788-A668-0080992DAED9::ATCH::INLINE::IA-3EC366E1-DCC8-4EF3-B5F1-555EA57B7612 description: The unique ID of the image file in its place as part of a risk attachmentID: type: string example: IA-3EC366E1-DCC8-4EF3-B5F1-555EA57B7612 description: The unique ID of the image file without associated risk data; the last delimited section of docID attachmentName: type: string example: image.png description: The filename of the image headingAlign: type: string description: The alignment of the heading on the page, either left or centre example: left tagPages: type: array description: The pages (aka groups) of Defined Data tags associated with the line item. Empty if there is no tagged data in the line item items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/tagPages/items' placeholders: type: array description: The array of placeholders which specify the location of the line item's tagged data values. Each item of tagged data has its own placeholder items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/placeholders/items' elements: type: array description: The array of individual pieces of text held in the line item items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/elements/items' potentialSection: type: string description: The MRC name of the contract section where the current mrcHeading is normally expected, if different to the actual mrcSection. This string is rarely used example: RiskDetails fragments: type: array deprecated: true description: A deprecated array which should be left empty items: type: object subItems: type: array deprecated: true description: A deprecated array which should be left empty items: type: object vertical: type: object properties: id: type: string description: If the line item is a vertical term, this contains the unique ID of the vertical example: VDCD69D9B-7195-4021-927E-43B9F1F9AEDD_2 assignedCarrierPrefixes: type: array items: type: string example: toymunderwriting description: The channel prefix (the first section of the channel name) of carrier/s assigned this version of the vertical term /api/risks/{riskID}/markAsFirmOrder: post: summary: The broker converts a quoted risk into a firm order - Broker Only description: An empty payload of {} is required for this endpoint tags: - Risks parameters: - in: path name: riskID schema: type: string example: ICB2906C80-AC59-4B3A-B4AC-643E340D5B30::MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE::UQ required: true description: The unique ID of the risk, starting IC and having parts delimited by '::' requestBody: description: Please add an empty payload of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: successfully marked as Firm Order content: application/json: schema: type: object properties: msg: type: string description: A message indicating success example: doc with id ICB2906C80-AC59-4B3A-B4AC-643E340D5B30::MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE::UQ1 successfully marked as firm order /api/risks/{riskID}/markAsIndicative: post: summary: The underwriter sets or unsets the indicative flag for an Underwriter Quotation ::UQx tags: - Risks parameters: - in: path name: riskID schema: type: string example: ICB2906C80-AC59-4B3A-B4AC-643E340D5B30::MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE::UQ1 required: true description: The unique ID of the risk, starting IC and having parts delimited by '::'. This must be an underwriter quotation, so the riskID will end UQx where x is 1, 2... requestBody: content: application/json: schema: type: object properties: indicative: type: boolean description: true if the quotation is indicative, false if it is noe example: true responses: '200': description: The full JMRC of the risk. In the JSON, .control.isIndicative will be updated to the new true/false value (not shown in the example). content: application/json: schema: type: array items: $ref: '#/components/schemas/RWPlacing' /api/risks/{riskID}/requestWrittenLineSets: post: summary: Sends a Firm Order/Bindable Quote risk to a carrier for a Written Line - Broker Only description:
The payload covers various options which the broker can set, including the percentage range for the Written Line and the Stamp to be used. Multiple carriers can be approached with one endpoint call.
tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and having parts delimited by '::' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: content: application/json: schema: type: object properties: _rev: type: string description: the revision number for the risk example: 1-de9bba4cb8ea75572af90209683166c6 stampVisibility: type: string description: Only set for the first underwriter you show to. Decides whose stamps underwriters can see. Allstamps is the default if stampVisibility is not included in payload. enum: - Allstamps - OwnStampsOnly - LeadersStamps messages: type: array items: type: object properties: channel: type: string description: channel of underwriter you are sending message to example: tomyunderwriting_ALL elements: type: array items: type: object description: main body of the message properties: text: type: string example: Please Accept index: type: integer example: 0 greeting: type: string description: The header of the message example: Hello closing: type: string example: The Closing statement description: Best Regards contents: type: array items: type: object properties: teamId: type: string example: MARINEHULL description: the broker or carrier team, all uppercase no spaces companyId: type: string example: WHITECLIFFS description: the broker or carrier company, all uppercase no spaces userId: type: string description: unique identifier for the individual user at a company, starting MU example: MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE sections: type: array items: type: object properties: min: type: number description: the minimum percentage line allowed example: 33.33 max: type: number description: the maximum percentage line allowed example: 66.67 leader: type: boolean description: true if the underwriter is to be the lead on the risk example: false stamps: type: array description: leave empty to allow the underwriter to choose from all available stamps items: $ref: '#/components/schemas/CorporateDetail/properties/stamps/items' sectionID: type: string description: Only needed if risk is sectioned. ID of the section you are showing to example: '1' attachments: type: array items: type: object properties: docID: type: string description: docId of the attahcment you want to send example: ICD543E41B-D57A-4F82-921B-2955107A328F::ATCH::A-2DD69B77-97CB-4956-8905-A0B045798BED attachID: type: string description: ID of the attachment example: A-2DD69B77-97CB-4956-8905-A0B045798BED channels: type: array items: type: string description: channels of the carrier you want to send attachment to example: whitesails_MARINE responses: '200': description: successfully requested a line content: application/json: schema: type: object properties: msg: type: string example: Line guidances sent. description: A message indicating success /api/risks/{riskID}/showQuoteToBroker: post: summary: The Underwriter sends an Underwriter Quotation back to the Broker - Underwriter Only description: No payload is required for this endpoint tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and expected to end ::UQx where x is 1, 2, 3 etc example: IC8F2D09C8-A220-4DD6-9E14-77AFF7A617AC::MU71BA6F2F-FFD1-4A92-86AC-5277FEAF3012::UQ4 responses: '200': description: successfully quoted content: application/json: schema: type: object properties: msg: type: string description: a message showing a successful result example: doc with id IC8F2D09C8-A220-4DD6-9E14-77AFF7A617AC::MU71BA6F2F-FFD1-4A92-86AC-5277FEAF3012::UQ4 successfully shown to broker /api/risks/{riskID}/showToLeadUnderwriter: post: summary: Shows a draft risk to an underwriter for quoting - Broker Only tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The root ID of the risk, starting IC and stopping before any '::' delimiters. The POST payload has several optional parameters -- 'userId' specifies the uniqueID of a specific user to show the draft to, 'messages' includes a broker's message with the contract, and 'attachments' identifies attachments to show. example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 requestBody: content: application/json: schema: type: object properties: teamId: type: string description: The carrier team to show the draft to. All uppercase, no spaces example: MARINEHULL companyId: type: string description: The carrier company to show the draft to. All uppercase, no spaces example: WHITECLIFFS userId: type: string description: Optional. Include to specify the MU identifier of the individual underwriter to show the draft to example: MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE facilityID: type: string description: Required if the risk is a declaration. Specifies the facility agreement that the draft is being shown under example: ICCDA7C650-47DB-40E5-B8C0-588867E6BB6D messages: type: array description: Optional. Include to provide an accompanying broker's message items: type: object properties: channel: type: string description: The receipient's channel ID example: whitecliffs_MARINEHULL elements: type: array items: type: object properties: text: type: string example: Please agree description: The body of the message index: type: integer example: 0 greeting: type: string example: Hello description: The header text of the message closing: type: string example: Best regards description: The footer text of the message attachments: type: array description: Optional. Include to specify attachment/s to show with the draft items: type: object properties: attachID: type: string example: A-77C8A342-DCDA-410B-9292-B3CD3105FC10 description: The ID of the attachment docID: type: string example: IC2B5E02ED-FF47-4BB6-98F5-8C85F1E052B5::ATCH::A-77C8A342-DCDA-410B-9292-B3CD3105FC10 description: The unique ID of the attachment document channels: type: array items: type: string example: whitecliffs_MARINEHULL description: The channel of the recipient to show the attachment to responses: '200': description: successfully showed the quote to an underwriter content: application/json: schema: type: object properties: msg: type: string example: Shown ICC81F7C6D-90D8-430B-9514-30B9A2614612 to Underwriter MARINEHULL at WHITECLIFFS /api/risks/{riskID}/signSets: post: summary: Sign the written lines on a Firm Order, promoting the risk to signed status - Broker Only description:The payload must include one written line set identifying the line or lines written by an underwriter, along with the percentage of the risk signed to that line. This set can include a section ID reference, and multiple sets may be written so long as the total percentage written does not exceed 100%.
tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk's firm order, starting with IC and having parts delimited by '::FO' example: ICEB56176E-D379-4B23-BD18-64EC5C841573::FO requestBody: description: JSON payload required: true content: application/json: schema: items: type: object properties: wSetID: type: string description: The ID reference specifying a specific written line set. example: IC733AB61B-75D0-4900-89EA-F059D7F57FE2::FO::PALERMO::ALL::WRLS items: type: array items: type: object properties: sectionIDs: type: array description: The section number of the risk that the specified written line applies to. items: type: string example: '1' percentages: type: array description: The numeric percentage being signed to that written line. items: type: string example: '60' examples: Open Market Simple: summary: A simple sign set example value: - wSetID: ICEB56176E-D379-4B23-BD18-64EC5C841573::FO::MESSINA::ALL::WRLS items: - sectionIDs: [] percentages: - '100' Open Market Complex: summary: Open Market Complex Example value: - wSetID: IC733AB61B-75D0-4900-89EA-F059D7F57FE2::FO::MESSINA::ALL::WRLS items: - sectionIDs: [] percentages: - '60' - wSetID: IC733AB61B-75D0-4900-89EA-F059D7F57FE2::FO::PALERMO::ALL::WRLS items: - sectionIDs: [] percentages: - '22.2222' - wSetID: IC733AB61B-75D0-4900-89EA-F059D7F57FE2::FO::SIRACUSA::ALL::WRLS items: - sectionIDs: [] percentages: - '17.7778' Declaration Shown to Multi Section Facility: summary: Multi-section facility value: - wSetID: ICC002A9C1-89C9-4B00-9807-4453DFA80853::FO::TOMYUNDERWRITING::ALL::WRLS items: - sectionIDs: [] percentages: - '50' associatedFacilityID: facilityID: ICD77B5FD4-0790-42B9-BC53-65242FB96558 sectionID: '1' responses: '200': description: successfully signed lines content: application/json: schema: type: object properties: msg: type: string example: Successfully signed lines! description: Success is confirmed by the message 'Successfully signed lines!' '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/reSignSets: post: summary: Update the Signed Lines on a Signed Risk - Broker Only description: The payload must include one signed line set -- i.e docs ending with ::SILS -- identifying the line or lines written by an underwriter, along with the percentage of the risk signed to that line. This set can include a section ID reference, and multiple sets may be written. Total of signed lines cannot exceed total of written lines or 100%. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the signed risk, starting with IC and having parts delimited by '::SIGNED' example: ICEB56176E-D379-4B23-BD18-64EC5C841573::SIGNED requestBody: description: JSON payload required: true content: application/json: schema: properties: wSetID: type: string description: ID of the signed line set example: IC11FC73F5-402A-44CD-AA9B-633259574B90::FO::PALERMO::ALL::SILS items: type: array items: type: object properties: sectionIDs: type: string description: The number of the risk's section that the signed line applies to. example: '1' percentages: type: string description: The numeric percentage being signed to the written line. example: '60' examples: simple: value: - wSetID: ICD875FA8F-F588-41FA-AA98-BE14A535B545::FO::TOMYUNDERWRITING::ALL::SILS items: - sectionIDs: [] percentages: - '90' complex: value: - wSetID: IC11FC73F5-402A-44CD-AA9B-633259574B90::FO::PALERMO::ALL::SILS items: - sectionIDs: - '1' percentages: - '80' - sectionIDs: - '2' percentages: - '83.3333' - wSetID: IC11FC73F5-402A-44CD-AA9B-633259574B90::FO::MESSINA::ALL::SILS items: - sectionIDs: - '1' percentages: - '20' - sectionIDs: - '2' percentages: - '16.6667' responses: '200': description: successfully re-signed content: application/json: schema: type: array items: type: object properties: rev: type: string description: new revision number example: 1-5e6cfb565e6c4457f9ddedf88442e878 id: type: string example: ID description: Id of the changed document example: - rev: 1-5e6cfb565e6c4457f9ddedf88442e878 id: ICB333DE48-8A44-47A8-BBED-E80B78FB736D::RWResignedLines::1691753008::887A9F05-5745-44A6-9E02-9A0738976AA3 - id: ICB333DE48-8A44-47A8-BBED-E80B78FB736D::FO::TOMYUNDERWRITING::ALL::SILS rev: 2-53b67a68a4822f36e0c73b744bbaaed8 - id: ICB333DE48-8A44-47A8-BBED-E80B78FB736D::SIGNED::TOMYUNDERWRITING::ALL rev: 2-ffc29c3c3687e7da519a03083d630872 - id: ICB333DE48-8A44-47A8-BBED-E80B78FB736D::SIGNED rev: 2-f62ac6070164fc3dc527af9f4e432ab2 - id: ICB333DE48-8A44-47A8-BBED-E80B78FB736D::SIGNED::ARCH::D8B3CD82-13C8-4F95-B32C-59FFAE1501EA rev: 1-2cb2e9604aa2732c156d8c4952080ef2 - id: ICB333DE48-8A44-47A8-BBED-E80B78FB736D::SIGNED::ACTI::A1E5D8E7-D2CB-497E-80DC-0ECA7FA5E8C8 rev: 1-fd42e2e456272f33005d436540c3c044 '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/writeLine: post: summary: Writes a line to the risk - Underwriter Only description:The payload must include one stamp detailed as line percentage, year and stamp ID, with references. It can optionally include section ID references, multiple stamps, and details of line conditions or subjectivities.
tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk's firm order, starting with IC and having parts delimited by '::FO::{COMPANYID}::{TEAMID}' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO::TOMYUNDERWRITING::MARINE requestBody: description: JSON payload required: true content: application/json: schema: type: object properties: _rev: type: string description: The system-generated version number of the firm order for the line to be written to. The number before the - is generated sequentially, starting at 1' example: 1-a302cd4445e3d12c33fdabf467e2789b line: type: object properties: sectionIDs: type: array description: The section number of the risk that the written line applies to. items: type: string example: '1' impressions: type: array items: type: object properties: writtenPercentage: type: string description: The percentage of the risk to write as a line. This must meet the line guidance in the firm order. example: '60' stampID: type: string description: The document ID of the stamp to be used in writing the line, beginning with ST. A company''s stamp list can be retrieved using /documents/Corporate-{companyID} example: ST1843A345-1F69-435D-84E9-187BB3DD0F23 yearOfAccount: type: string description: The year of accounting for the line. Only needed for the lead line. example: '2022' references: type: array items: type: object properties: reference: type: string description: The underwriter''s reference code for the line. example: 22FB238273XX riskCodes: type: string description: The category code describing the subject of the line. example: H3 description: type: string description: A free text comment field for the line. example: Ref:0023 mirrorStampData: type: array items: type: object properties: mirrorStampReferences: type: array description: the mirror stamp reference code items: example: 22FB238 mirrorStampDescriptions: type: array description: A free text comment field for the mirror stamp. items: example: REF:025 type: string mirrorStampID: type: string example: STDECAA286-05B2-4FEA-942E-09A3EC352030 description: The document ID of the stamp to be used as a mirror, beginning with ST. A company''s stamp list can be retrieved using /documents/Corporate-{companyID} mirrorStampCustomDescription: type: string example: Applying to EEA risks description: The text description of the cover associated with the mirror stamp. conditions: type: object properties: lineConditions: type: array description: The set of line conditions added by the underwriter items: type: string example: Line To stand subjectivityMode: type: string enum: - unchosen - holdingCover - noCoverGiven description: Whether the line provides ongoing cover while the specified subjectivity requirements are being agreed subjectivities: type: array description: Details of subjectivity requirements added by the underwriter items: type: object properties: deadline: type: string example: '1708560000.0' description: The deadline for accepting the subjectivity response, in unix epoch time identifier: type: string example: '' description: The uniqueID of the subjectivity. Leave blank, as the platform will auto-generate this text: type: string example: Sample Subjectivity description: Text detailing the requirement of the subjectivity subjectivitiesDeadlineNotRequired: type: string description: Text detailing any subjectivity requirements which do not have a deadline examples: simple: value: _rev: 1-1fb5b6812cb938636e5b1a3de968ce6a line: sectionIDs: [] impressions: - references: - reference: 22FB238273XX riskCodes: X1 description: Ref:0023 writtenPercentage: '100' stampID: ST1843A345-1F69-435D-84E9-187BB3DD0F23 yearOfAccount: '2022' conditions: lineConditions: [] subjectivities: [] conditionsAndSubjectivities: value: _rev: 1-0f9d0731df4d917b0daba4974b7a647e line: sectionIDs: [] impressions: - references: - reference: LINECONSSUBS riskCodes: '' description: '' writtenPercentage: '100' stampID: ST1843A345-1F69-435D-84E9-187BB3DD0F23 yearOfAccount: '2022' conditions: lineConditions: - LINE TO STAND - COPY POLICY WORDING subjectivityMode: holdingCover subjectivities: - approvedStatus: notYetResponded text: Survey required deadline: '1661295600' identifier: '' deadlineNotRequired: All claims to be filed electronically. mirrorStamps: value: _rev: 5-14d501d94a1160c1f6b151633afd733f line: sectionIDs: [] impressions: - references: - reference: SADASD riskCodes: '' description: '' mirrorStampData: - mirrorStampReferences: - DSDSAD mirrorStampDescriptions: - '' mirrorStampID: STDECAA286-05B2-4FEA-942E-09A3EC352030 mirrorStampCustomDescription: Applying to EEA risks writtenPercentage: '100' stampID: STDCEB5FD2-E54C-4596-B0D8-4C50B63F27BA conditions: lineConditions: [] subjectivities: [] multipleStamps: value: _rev: 3-e745086500eb2da786bb628b8d62dd4e line: sectionIDs: [] impressions: - references: - reference: REF1 riskCodes: '' description: '' writtenPercentage: '50' stampID: STDCEB5FD2-E54C-4596-B0D8-4C50B63F27BA - references: - reference: REF2 riskCodes: '' description: '' writtenPercentage: '50' stampID: STDECAA286-05B2-4FEA-942E-09A3EC352030 conditions: lineConditions: [] subjectivities: [] responses: '200': description: successfully written lines content: application/json: schema: type: object properties: msg: type: string example: Wrote line. description: Success is confirmed by the message 'Wrote line.' '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/newDraft: post: tags: - Risks summary: Creates a draft risk using a simplified input format - Broker Only parameters: - in: query name: teamChannel required: true schema: type: string description: The team channel where the new Draft Risk is to be created. This string always takes the format "company_DEPARTMENT" and a full list of available channels for a user can be seen in the response to a GET request to /api/user/myDetails. This value is the equivalent of selecting a Team in the "Create for Team" dropdown box when creating a new Risk in the web UI requestBody: description:An array of simplified line items. Note that each should have either text, for a single line, or array for several paragraphs. Dates, amounts etc will be picked out as placeholders if they follow our conventions. If both are supplied the array takes precedence.
required: true content: application/json: schema: type: array items: type: object properties: heading: type: string description: the heading for the line item example: Insured text: type: string description: a single line of text for the line item detail example: GBP 250,000 array: type: array description: one line per paragraph for the line item detail items: type: string example: - From 1 April 2020 - To 31 March 2021 example: - heading: UMR text: B0999JC0212211614 - heading: Insured text: Swagger Widgets Inc - heading: Contract Type text: Cyber Insurance - heading: Period array: - From 1 April 2021 - To 31 March 2022 - heading: Premium text: USD 25,000 - heading: Limit of Liability text: USD 40,000,000 responses: '200': description: OK content: application/json: example: id: IC4F06B6BD-20EE-41BC-87F7-1292B7750C9B rev: 1-141df67df9e5eaacd0830c65e47a0bf9 ok: true '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/root/{rootID}: get: tags: - Risks summary: Get a list of documents associated with a risk parameters: - in: path name: rootID schema: type: string required: true description: 'The root ID of the risk, stopping before the :: suffix' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: string example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::QR1 description: The full ID of the document type: type: string example: RWPlacing description: The type of the document, which will always be RWPlacing channels: type: array items: type: string description: The channels of the user teams that can see the document example: - ajc_ALL - messina_ALL '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{rootID}/related/{type}: get: tags: - Risks summary: returns documents of a certain type for a risk parameters: - in: path name: rootID schema: type: string required: true description: 'The root ID of the risk, stopping before the :: suffix' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 - in: path name: type schema: type: string required: true description: The document type to be fetched, for instance RWComment, RWLineGuidanceSet, RWWrittenLineSet, RWSignedLineSet example: RWComment responses: '200': description: An array of documents for the required type content: application/json: schema: type: array items: type: object description: documents of the specified type '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/save: post: tags: - Risks summary: Create a new risk from a full JMRC - Broker Only requestBody: description: JMRC object required: true content: application/json: schema: type: object properties: MRCContract: type: object properties: lineItems: type: array items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1lineitem~1%7BmrcHeading%7D/get/responses/200/content/application~1json/schema/items' examples: simple: value: MRCContract: lineItems: - elements: [] fragments: [] index: 0 mrcHeading: NonMRCHeading mrcSection: RiskDetails nameVariation: NonMRCHeading originalHeading: RISK DETAILS originalSection: self placeholders: [] subItems: [] - elements: - index: 0 text: B13123123 fragments: [] index: 1 mrcHeading: UMR mrcSection: RiskDetails nameVariation: UMR originalHeading: UMR originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 2 mrcHeading: ContractType mrcSection: RiskDetails nameVariation: ContractType originalHeading: TYPE originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 3 mrcHeading: Insured mrcSection: RiskDetails nameVariation: Insured originalHeading: INSURED originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 4 mrcHeading: PrincipalAddress mrcSection: RiskDetails nameVariation: PrincipalAddress originalHeading: PRINCIPAL ADDRESS originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 5 mrcHeading: Period mrcSection: RiskDetails nameVariation: Period originalHeading: PERIOD originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 6 mrcHeading: Interest mrcSection: RiskDetails nameVariation: Interest originalHeading: INTEREST originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 7 mrcHeading: LimitOfLiability mrcSection: RiskDetails nameVariation: LimitOfLiability originalHeading: LIMIT OF LIABILITY originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 8 mrcHeading: ReInsuredsRetention mrcSection: RiskDetails nameVariation: ReInsuredsRetention originalHeading: (RE)INSURED'S RETENTION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 9 mrcHeading: Situation mrcSection: RiskDetails nameVariation: Situation originalHeading: SITUATION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 10 mrcHeading: ChoiceOfLawAndJurisdiction mrcSection: RiskDetails nameVariation: ChoiceOfLawAndJurisdiction originalHeading: CHOICE OF LAW & JURISDICTION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 11 mrcHeading: Premium mrcSection: RiskDetails nameVariation: Premium originalHeading: PREMIUM originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 12 mrcHeading: PremiumPaymentTerms mrcSection: RiskDetails nameVariation: PremiumPaymentTerms originalHeading: PREMIUM PAYMENT TERMS originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 13 mrcHeading: TaxesPayableByInsuredAndAdministeredByInsurers mrcSection: RiskDetails nameVariation: TaxesPayableByInsuredAndAdministeredByInsurers originalHeading: TAXES PAYABLE BY INSURED AND ADMINISTERED BY INSURER(S) originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 14 mrcHeading: TaxesPayableByInsurersAndAdministeredByInsuredOrTheirAgent mrcSection: RiskDetails nameVariation: TaxesPayableByInsurersAndAdministeredByInsuredOrTheirAgent originalHeading: TAXES PAYABLE BY INSURERS AND ADMINISTERED BY INSURED OR THEIR AGENT originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 15 mrcHeading: RecordingTransmittingAndStoringInformation mrcSection: RiskDetails nameVariation: RecordingTransmittingAndStoringInformation originalHeading: RECORDING, TRANSMITTING & STORING INFORMATION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 16 mrcHeading: InsurerContractDocumentation mrcSection: RiskDetails nameVariation: InsurerContractDocumentation originalHeading: INSURER CONTRACT DOCUMENTATION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 17 mrcHeading: NonMRCHeading mrcSection: Information nameVariation: NonMRCHeading originalHeading: INFORMATION originalSection: self placeholders: [] subItems: [] - elements: [] fragments: [] index: 18 mrcHeading: Information mrcSection: Information nameVariation: Information originalHeading: INFORMATION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 19 mrcHeading: NonMRCHeading mrcSection: SecurityDetails nameVariation: NonMRCHeading originalHeading: SECURITY DETAILS originalSection: self placeholders: [] subItems: [] - elements: [] fragments: [] index: 20 mrcHeading: ReinsurersLiability mrcSection: SecurityDetails nameVariation: ReinsurersLiability originalHeading: REINSURER'S LIABILITY originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 21 mrcHeading: OrderHereon mrcSection: SecurityDetails nameVariation: OrderHereon originalHeading: ORDER HEREON originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 22 mrcHeading: BasisOfWrittenLines mrcSection: SecurityDetails nameVariation: BasisOfWrittenLines originalHeading: BASIS OF WRITTEN LINES originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 23 mrcHeading: SigningProvisions mrcSection: SecurityDetails nameVariation: SigningProvisions originalHeading: SIGNING PROVISIONS originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 24 mrcHeading: InsurersWrittenLine mrcSection: SecurityDetails nameVariation: InsurersWrittenLine originalHeading: INSURER'S WRITTEN LINE originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 25 mrcHeading: NonMRCHeading mrcSection: SubscriptionAgreement nameVariation: NonMRCHeading originalHeading: SUBSCRIPTION AGREEMENT originalSection: self placeholders: [] subItems: [] - elements: [] fragments: [] index: 26 mrcHeading: NoticeOfCancellationProvisions mrcSection: SubscriptionAgreement nameVariation: NoticeOfCancellationProvisions originalHeading: NOTICE OF CANCELLATION PROVISIONS originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 27 mrcHeading: SlipLeader mrcSection: SubscriptionAgreement nameVariation: SlipLeader originalHeading: SLIP LEADER originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 28 mrcHeading: BureauLeader mrcSection: SubscriptionAgreement nameVariation: BureauLeader originalHeading: BUREAU LEADER originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 29 mrcHeading: BasisOfAgreementToContractChanges mrcSection: SubscriptionAgreement nameVariation: BasisOfAgreementToContractChanges originalHeading: BASIS OF AGREEMENT TO CONTRACT CHANGES originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 30 mrcHeading: OtherAgreementPartiesForContractChangesForPart2GUAChangesOnly mrcSection: SubscriptionAgreement nameVariation: OtherAgreementPartiesForContractChangesForPart2GUAChangesOnly originalHeading: OTHER AGREEMENT PARTIES FOR CONTRACT CHANGES, FOR PART 2 GUA CHANGES ONLY originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 31 mrcHeading: AgreementPartiesForContractChangesForTheirProportionOnly mrcSection: SubscriptionAgreement nameVariation: AgreementPartiesForContractChangesForTheirProportionOnly originalHeading: AGREEMENT PARTIES FOR CONTRACT CHANGES, FOR THEIR PROPORTION ONLY originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 32 mrcHeading: BasisOfClaimsAgreement mrcSection: SubscriptionAgreement nameVariation: BasisOfClaimsAgreement originalHeading: BASIS OF CLAIMS AGREEMENT originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 33 mrcHeading: ClaimsAgreementParties mrcSection: SubscriptionAgreement nameVariation: ClaimsAgreementParties originalHeading: CLAIMS AGREEMENT PARTIES originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 34 mrcHeading: ClaimsAdministration mrcSection: SubscriptionAgreement nameVariation: ClaimsAdministration originalHeading: CLAIMS ADMINISTRATION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 35 mrcHeading: RulesAndExtentOfAnyOtherDelegatedClaimsAuthority mrcSection: SubscriptionAgreement nameVariation: RulesAndExtentOfAnyOtherDelegatedClaimsAuthority originalHeading: RULES AND EXTENT OF ANY OTHER DELEGATED CLAIMS AUTHORITY originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 36 mrcHeading: ExpertsFeesCollection mrcSection: SubscriptionAgreement nameVariation: ExpertsFeesCollection originalHeading: EXPERT(S) FEES COLLECTION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 37 mrcHeading: SettlementDueDate mrcSection: SubscriptionAgreement nameVariation: SettlementDueDate originalHeading: SETTLEMENT DUE DATE originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 38 mrcHeading: BureauxArrangements mrcSection: SubscriptionAgreement nameVariation: BureauxArrangements originalHeading: BUREAUX ARRANGEMENTS originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 39 mrcHeading: NonMRCHeading mrcSection: FiscalAndRegulatory nameVariation: NonMRCHeading originalHeading: FISCAL AND REGULATORY originalSection: self placeholders: [] subItems: [] - elements: [] fragments: [] index: 40 mrcHeading: TaxPayableByInsurers mrcSection: FiscalAndRegulatory nameVariation: TaxPayableByInsurers originalHeading: TAX PAYABLE BY INSURER(S) originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 41 mrcHeading: CountryOfOrigin mrcSection: FiscalAndRegulatory nameVariation: CountryOfOrigin originalHeading: COUNTRY OF ORIGIN originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 42 mrcHeading: OverseasBroker mrcSection: FiscalAndRegulatory nameVariation: OverseasBroker originalHeading: OVERSEAS BROKER originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 43 mrcHeading: AllocationOfPremiumToCoding mrcSection: FiscalAndRegulatory nameVariation: AllocationOfPremiumToCoding originalHeading: ALLOCATION OF PREMIUM TO CODING originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 44 mrcHeading: RegulatoryClientClassification mrcSection: FiscalAndRegulatory nameVariation: RegulatoryClientClassification originalHeading: REGULATORY CLIENT CLASSIFICATION originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 45 mrcHeading: NonMRCHeading mrcSection: BrokerRemunerationAndDeductions nameVariation: NonMRCHeading originalHeading: BROKER REMUNERATION & DEDUCTIONS originalSection: self placeholders: [] subItems: [] - elements: [] fragments: [] index: 46 mrcHeading: FeePayableByClient mrcSection: BrokerRemunerationAndDeductions nameVariation: FeePayableByClient originalHeading: FEE PAYABLE BY CLIENT? originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 47 mrcHeading: TotalBrokerage mrcSection: BrokerRemunerationAndDeductions nameVariation: TotalBrokerage originalHeading: TOTAL BROKERAGE originalSection: '' placeholders: [] subItems: [] - elements: [] fragments: [] index: 48 mrcHeading: OtherDeductionsFromPremium mrcSection: BrokerRemunerationAndDeductions nameVariation: OtherDeductionsFromPremium originalHeading: OTHER DEDUCTIONS FROM PREMIUM originalSection: '' placeholders: [] subItems: [] complex: value: MRCContract: lineItems: - fragments: [] originalHeading: 'RISK DETAILS ' nameVariation: NonMRCHeading mrcSection: RiskDetails placeholders: [] elements: [] originalSection: self index: 0 subItems: [] mrcHeading: NonMRCHeading - subItems: [] originalHeading: UMR elements: - index: 0 text: B123123123123 mrcHeading: UMR fragments: [] originalSection: '' nameVariation: UMR placeholders: [] mrcSection: RiskDetails index: 1 - nameVariation: Company originalHeading: COMPANY subItems: [] elements: - index: 0 text: Swagger Simple Save Example mrcHeading: Insured locked: false fragments: [] originalSection: '' placeholders: [] tagPages: - title: '' sectionIDs: [] pageID: 9763BF50-3F8A-40B2-A2A8-6C20E709B2DB index: 2 mrcSection: RiskDetails - subItems: [] originalHeading: ADDRESS elements: - index: 0 text: 11 Amelia Earhart Way, Rongotai, Wellington 6003, New Zealand mrcHeading: PrincipalAddress fragments: [] nameVariation: Address placeholders: [] originalSection: '' mrcSection: RiskDetails index: 3 - mrcHeading: Period originalHeading: PERIOD nameVariation: Period locked: false mrcSection: RiskDetails placeholders: - value: 31 August 2021 originalValue: 31 August 2021 name: DefinedData0 phType: Date tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Inception_Date - value: 31 August 2022 originalValue: 31 August 2022 name: DefinedData1 phType: Date tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Expiry_Date - value: 12.01 a.m. originalValue: 12.01 a.m. name: DefinedData2 phType: DefinedData tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Inception_Time - Expiry_Time - value: Local Standard Time originalValue: Local Standard Time name: DefinedData3 phType: DefinedData tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Time_Qualifier index: 4 elements: - index: 0 text: 'From: [[DefinedData0]]' - index: 1 text: 'To: [[DefinedData1]]' - index: 2 text: Both days at [[DefinedData2]] [[DefinedData3]] at the location of the property insured. originalSection: '' subItems: [] tagPages: - title: '' sectionIDs: [] pageID: 17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 fragments: [] - originalHeading: TYPE mrcHeading: ContractType nameVariation: ContractType mrcSection: RiskDetails placeholders: [] index: 5 elements: - index: 0 text: Aviation Hull and Liability Insurance originalSection: '' subItems: [] fragments: [] - mrcHeading: LimitOfLiability fragments: [] nameVariation: LimitsOfLiability locked: false mrcSection: RiskDetails placeholders: - value: USD 100,000,000 originalValue: USD 100,000,000 name: Amount1 phType: Amount elements: - index: 0 text: '[[Amount1]] each and every loss sdfsdf' index: 6 tagPages: - title: '' sectionIDs: [] pageID: 0EA4F5E0-05D5-4B74-B5B0-2CF56B0AD774 subItems: [] originalSection: '' originalHeading: LIMITS OF LIABILITY - originalHeading: PREMIUM fragments: [] nameVariation: Premium locked: false mrcSection: RiskDetails placeholders: - value: 100% originalValue: 100% name: Percentage1 phType: Percentage - value: USD 5,500,000 originalValue: USD 5,500,000 name: DefinedData0 phType: Amount tags: - Page:6A45CE72-A1D1-4270-B767-0DDAF5FF0735 - Premium_Amount - value: annual originalValue: annual name: DefinedData1 phType: DefinedData tags: - Page:6A45CE72-A1D1-4270-B767-0DDAF5FF0735 - Premium_Period_Qualifier elements: - index: 0 text: ' [[DefinedData0]] ([[Percentage1]]) [[DefinedData1]]' tagPages: - pageID: 6A45CE72-A1D1-4270-B767-0DDAF5FF0735 sectionIDs: [] title: '' originalSection: '' subItems: [] index: 7 mrcHeading: Premium - fragments: [] originalHeading: 'INFORMATION ' nameVariation: NonMRCHeading mrcSection: Information placeholders: [] elements: [] originalSection: self index: 8 subItems: [] mrcHeading: NonMRCHeading - originalHeading: INFORMATION mrcHeading: Information nameVariation: Information locked: false mrcSection: Information placeholders: [] elements: - index: 0 text: '' index: 9 tagPages: - pageID: F479C70D-2059-417F-98F6-64F9F041BD37 sectionIDs: [] title: '' subItems: [] originalSection: '' fragments: [] - fragments: [] mrcHeading: NonMRCHeading nameVariation: NonMRCHeading mrcSection: SecurityDetails placeholders: [] index: 15 originalSection: self elements: [] subItems: [] originalHeading: 'SECURITY DETAILS ' - originalHeading: WRITTEN LINES mrcHeading: InsurersWrittenLine nameVariation: InsurersWrittenLine mrcSection: SecurityDetails placeholders: [] index: 16 originalSection: '' elements: - index: 0 text: In a co-insurance placement, following (re)insurers may, but are not obliged to, follow the premium charged by the lead (re)insurer. - index: 1 text: (Re)insurers may not seek to guarantee for themselves terms as favourable as those which others subsequently achieve during the placement. subItems: [] fragments: [] - originalHeading: 'SUBSCRIPTION AGREEMENT ' fragments: [] nameVariation: NonMRCHeading mrcSection: SubscriptionAgreement placeholders: [] index: 10 originalSection: self elements: [] subItems: [] mrcHeading: NonMRCHeading - fragments: [] mrcHeading: SlipLeader nameVariation: SlipLeader mrcSection: SubscriptionAgreement placeholders: [] index: 11 originalSection: '' elements: - index: 0 text: The Slip Leader is ENTER SLIP LEADER subItems: [] originalHeading: SLIP LEADER - originalHeading: BUREAU(X) LEADER(S) fragments: [] nameVariation: BureauLeader mrcSection: SubscriptionAgreement placeholders: [] index: 12 originalSection: '' elements: - index: 0 text: The Bureau(x) Leader(s) (where applicable) is AAA NNN subItems: [] mrcHeading: BureauLeader - fragments: [] originalHeading: 'FISCAL AND REGULATORY ' nameVariation: NonMRCHeading mrcSection: FiscalAndRegulatory placeholders: [] elements: [] index: 13 originalSection: self subItems: [] mrcHeading: NonMRCHeading - fragments: [] mrcHeading: NonMRCHeading nameVariation: NonMRCHeading mrcSection: BrokerRemunerationAndDeductions placeholders: [] index: 14 originalSection: self elements: [] subItems: [] originalHeading: 'BROKER REMUNERATION AND DEDUCTIONS ' parameters: - in: query required: true name: UMR description: Unique market reference example: B123123123123 schema: type: string - in: query required: true name: insuranceType description: Type of insurance schema: type: string enum: - Insurance - Reinsurance - in: query required: true name: contractType description: Type of contract schema: type: string example: Cyber Insurance - in: query required: true name: insuredName description: Name of the insured schema: type: string example: Acme Widgets Inc - in: query required: true name: teamChannel description: Whitespace team channel name example: lloydsbroker_AVIATION schema: type: string - in: query required: true name: placementType description: decides whether a risk or template is created schema: enum: - FullContract - Template type: string responses: '200': description: OK content: application/json: schema: type: object properties: ok: type: boolean example: true id: type: string example: IC0000000-000-00 rev: type: string description: Revision number of the newly created Risk example: 1-K23K2J2JL323IEOW '401': description: Unauthorized call content: application/json: schema: type: object properties: error: type: boolean example: true reason: type: string example: Invalid WSAUTH /api/risks/{EndorsementID}/showEndorsement: post: tags: - Risks summary: Show an endorsement to underwriters - Broker Only parameters: - in: path name: EndorsementID schema: type: string required: true description: The unique ID of the Endorsement example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO::EN1 requestBody: description: Can only show to "leader" or "agreementParty" content: application/json: schema: type: object properties: carriers: type: array description: The carrier team/s to be shown the risk items: type: object properties: channel: type: string example: whitesails_ALL role: type: string example: leader responses: '200': description: successfully showed endorsement content: application/json: schema: type: object properties: msg: type: string example: Shown. description: Success is confirmed by the message 'Shown.' '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{EndorsementID}/acceptEndorsement: post: summary: Accept an endorsement as an underwriter - Underwriter Only tags: - Risks parameters: - in: path name: EndorsementID schema: type: string example: ICF1317DDA-50DB-4611-8253-D3DA499F861C::FO::EN1 required: true description: The unique ID of the endorsement, starting IC and having parts delimited by '::'. This must be an endorsement, so the riskID will end ENx where x is 1, 2... requestBody: content: application/json: schema: type: object required: - channel properties: channel: type: string description: the channel for the underwriter's team example: palermo_ALL instruction: type: string description: For leaders only -- set to specify the underwriters who must agree the endorsement -- one of leaderOnly, leaderAndAgreementParties or allToAgree, otherwise omit the value example: leaderOnly notify_days: type: string description: leader only, optional -- the number of days the broker has to notify following parties example: '7' responses: '200': description: The full JMRC of the risk. In the JSON, .control.isIndicative will be updated to the new true/false value (not shown in the example). content: application/json: schema: type: object properties: msg: type: string description: an acceptance message example: accepted /api/risks/changeRiskName/{rootID}: post: summary: Change the name of the risk - Broker Only description: Risk name can only be changed if the risk has not been shown to any markets. parameters: - in: path name: rootID schema: type: string required: true description: The unique root ID of the risk example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 tags: - Risks requestBody: content: application/json: schema: type: object properties: newName: type: string description: The new name of the risk example: Acme Widgets responses: '200': description: A confirmation of the saved data content: application/json: schema: type: object properties: msg: type: string description: Message to confirm that the risk name has been updated example: Updated Risk Name /api/risks/{quoteID}/createDraftFromQuote: post: summary: Create an editable draft from a quote - Broker Only description: Broker accounts only. Duplicates an underwriter''s quote as a new editable draft under the same risk. This is only possible for risks that have not yet progressed to the firm order stage. tags: - Risks parameters: - in: path name: quoteID schema: type: string required: true description: The unique document ID of the quote, starting IC and ending ::UQx, where x is the number of the quote in order of quotes recieved, ie. 1, 2, 3 etc example: ICD77B5FD4-0790-42B9-BC53-65242FB96558::MU438E3843-63ED-47AD-9059-11E6FD1D000D::UQ1 responses: '200': description: successfully created Draft content: application/json: schema: type: object properties: msg: type: string description: a message showing that the draft has been created example: Draft created /api/risks/{riskID}/lineItemAttributes: post: tags: - Risks summary: Edit an attribute of a line item -- that is, one contract heading and its associated text -- such as locking the text to prevent further editing, or adding a page break parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 requestBody: content: application/json: examples: Add/Remove Page Break: description: Add or remove a page break to a heading value: index: 3 hasPageBreak: true Lock Text: description: Lock the text in a heading, Locktype options are "lockTextOnly", "lockAll", "lockTextOnlyTemplate", "lockAllTemplate" value: index: 3 lockType: lockTextOnly locked: true schema: properties: lockType: type: string description: required to be 'edit' example: edit hasPageBreak: type: boolean description: choose to add page break to heading or not example: true index: type: number description: the index of the line item to be changed example: 6 locked: type: boolean description: choose whether to lock or not example: true responses: '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/getQuoteDetails: get: tags: - Risks summary: Returns any information entered by the underwriter into a quote's 'Quote Details' panel. Underwriters are not required to use this panel when quoting, so some (or all) information may be blank. parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the quote, ending in ::UQ# (where example: ICCFD2A903-08B1-4E52-BD9B-57268B9723F8::MU999AF919-3FDB-49F2-B4C5-D42614B02E70::UQ1 responses: '200': description: successful response content: application/json: schema: type: object properties: buttonStampDetails: type: object properties: stampID: type: string example: BTN-BAB19551-5557-4E6B-888B-E3B1B6A0E982 description: The unique ID of the button stamp added by the underwriter validityPeriod: type: number description: The valdity period of the quote example: 7 notes: type: string example: Notes for the Quote description: Free-text notes added by the underwriter reference: type: string example: '123123123' description: The underwriter's reference number for the quote quotedLineSize: type: string example: '15' description: The quoted line percentage conditions: type: string example: Line To Stand description: Any subjectivities or conditions that the underwriter requires when writing a line on this contract indicatedStamps: type: array items: type: string example: Lloyds Syndicate 1256 description: The stamp that the underwriter is considering using when writing the line '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/saveQuoteDetails: post: summary: Edit and Save Quote Details - Underwriter Only description: Can edit the quote reference, any subjectivites/line conditions, notes, and the quote''s validity period, as well as indicate line stamps to use when writing and/or add button stamps tags: - Risks parameters: - in: path name: riskID schema: type: string example: ICB2906C80-AC59-4B3A-B4AC-643E340D5B30::MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE::UQ required: true description: The unique ID of the quote in preparation, starting IC and having parts delimited by ::, ending with UQ# where '#' is 1,2,3 etc requestBody: description: Payload only needs to be complete if you want to edit every detail, otherwise remove irrelvant fields required: true content: application/json: schema: properties: reference: type: string description: Quote Reference example: '121232131' conditions: type: string description: Subjectivites/ Line Conditions example: Line To Stand notes: type: string description: Notes example: Prefer to be leader validityPeriod: type: number description: Validity period in days example: 12 indicatedStamps: type: array description: Indication of the full stamp likely to be used when writing a line items: type: string example: Lloyds 1234 buttonStampDetails: type: object description: Button stamp details properties: stampID: type: string description: ID of the Button Stamp example: BTN-BAB19551-5557-4E6B-888B-E3B1B6A0E982 showOnEditedHeadings: type: boolean example: false quotedLineSize: type: string description: Quoted line percentage example: '12' responses: '200': description: successfully saved quote details content: application/json: schema: type: object properties: msg: type: string description: A message indicating success example: Successfully updated quote details. /api/risks/{riskID}/createBindableQuote: post: summary: Creates a Bindable Quote - Broker Only description: Bindable Quotes can be created from a risk at either the Draft or Quoted stage tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the source risk document, starting IC example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854 requestBody: description: Please add an empty payload of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: Successfully created a bindable quote content: application/json: schema: type: object properties: msg: type: string example: Created bindable quote from IC576DEFEE-7046-4E3A-B18E-2F69638E9939::MU999AF919-3FDB-49F2-B4C5-D42614B02E70::UQ1 description: A message indicating success /api/risks/{riskID}/selfApproveSecondApproval: post: summary: Self-approve one of your contracts flagged for internal review. NOTE You must have the 'Self Approver' role enabled for this API call to work. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and having parts delimited by '::' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: content: application/json: schema: type: object properties: notes: type: string description: Any notes you want to include in the record of the approval example: Approved responses: '200': description: Successfully self-approved content: application/json: schema: type: object properties: msg: type: string description: message describing success example: Successfully self-approved /api/risks/{riskID}/duplicateDraft: post: summary: Duplicate an existing draft contract under the same risk overview - Broker Only description: This endpoint requires the ID of the draft to duplicate as well as an empty {} payload. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the draft example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854 requestBody: description: Please add an empty payload of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: successfully duplicated draft content: application/json: schema: type: object properties: msg: type: string example: Created copy of Draft to Placing description: A message indicating success /api/risks/{riskID}/changeHeadings: post: summary: Delete contract headings from a risk. description: To delete one or more contract headings, use the Delete array in the request and leave the Insert and Modify arrays blank. Please note that certain headings, such as UMR, cannot be deleted. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk, starting IC and having parts delimited by '::' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: content: application/json: schema: type: object properties: insert: type: array items: type: string description: Leave blank delete: type: array description: The index numbers of the headings to be deleted. items: type: number example: 5 modify: type: array description: Leave blank items: type: string _rev: type: string description: The current revision number of the risk example: 1-da1ae8df074c21794643c87c4fda38f responses: '200': description: OK content: application/json: example: provenance: dataHash: 0aafa0694cc205cd9f6c6c214f2fa60290aec52a25a16298d4401979d25a6e34 userID: MU9FCFC64E-7694-420A-BE61-2ABEDB3E8F52 provHash: a0364567216c7041bcda197d50a49504ad4b75098c05e2c4bf8452f3e1e4f46f system: LaVAPI writtenAt: '2023-09-22 13:20:38' version: 2023-09-21@19:07:10 updatedAt: '2023-09-22 13:20:38' createdAt: '2023-05-05 11:38:23' type: RWPlacing _rev: 2-469f0a5e1c1817de973f7c84430f49eb control: insuredName: Acme Widgets Inc umr: B123123123123 placementType: FullContract createdInVersion: 21100 originalDocID: '' placingBrokerChannel: akhil_ALL isFacility: false status: NotFinalised insuranceType: Insurance placingBroker: AKHIL All Risks shownToUnderwriter: '' limitSummary: USD 100,000,000 contractType: Cyber Insurance proposedEndorsementFollowers: {} channels: - akhil_ALL _id: IC97799647-4496-4760-B594-02AC726B0D7E accountDocID: null MRCContract: lineItems: - fragments: [] originalHeading: 'RISK DETAILS ' nameVariation: NonMRCHeading mrcSection: RiskDetails placeholders: [] elements: [] originalSection: self index: 0 subItems: [] mrcHeading: NonMRCHeading - subItems: [] originalHeading: UMR elements: - index: 0 text: B123123123123 mrcHeading: UMR fragments: [] originalSection: '' nameVariation: UMR placeholders: [] mrcSection: RiskDetails index: 1 - nameVariation: Company originalHeading: COMPANY subItems: [] elements: - index: 0 text: Swagger Simple Save Example mrcHeading: Insured locked: false fragments: [] originalSection: '' placeholders: [] tagPages: - title: '' sectionIDs: [] pageID: 9763BF50-3F8A-40B2-A2A8-6C20E709B2DB index: 2 mrcSection: RiskDetails - subItems: [] originalHeading: ADDRESS elements: - index: 0 text: 11 Amelia Earhart Way, Rongotai, Wellington 6003, New Zealand mrcHeading: PrincipalAddress fragments: [] nameVariation: Address placeholders: [] originalSection: '' mrcSection: RiskDetails index: 3 - mrcHeading: Period originalHeading: PERIOD nameVariation: Period locked: false mrcSection: RiskDetails placeholders: - value: 31 August 2021 originalValue: 31 August 2021 name: DefinedData0 phType: Date tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Inception_Date - value: 31 August 2022 originalValue: 31 August 2022 name: DefinedData1 phType: Date tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Expiry_Date - value: 12.01 a.m. originalValue: 12.01 a.m. name: DefinedData2 phType: DefinedData tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Inception_Time - Expiry_Time - value: Local Standard Time originalValue: Local Standard Time name: DefinedData3 phType: DefinedData tags: - Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 - Time_Qualifier index: 4 elements: - index: 0 text: 'From: [[DefinedData0]]' - index: 1 text: 'To: [[DefinedData1]]' - index: 2 text: Both days at [[DefinedData2]] [[DefinedData3]] at the location of the property insured. originalSection: '' subItems: [] tagPages: - title: '' sectionIDs: [] pageID: 17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 fragments: [] - originalHeading: TYPE mrcHeading: ContractType nameVariation: ContractType mrcSection: RiskDetails placeholders: [] index: 5 elements: - index: 0 text: Aviation Hull and Liability Insurance originalSection: '' subItems: [] fragments: [] - mrcHeading: LimitOfLiability fragments: [] nameVariation: LimitsOfLiability locked: false mrcSection: RiskDetails placeholders: - value: USD 100,000,000 originalValue: USD 100,000,000 name: Amount1 phType: Amount elements: - index: 0 text: '[[Amount1]] each and every loss sdfsdf' index: 6 tagPages: - title: '' sectionIDs: [] pageID: 0EA4F5E0-05D5-4B74-B5B0-2CF56B0AD774 subItems: [] originalSection: '' originalHeading: LIMITS OF LIABILITY - originalHeading: PREMIUM fragments: [] nameVariation: Premium locked: false mrcSection: RiskDetails placeholders: - value: 100% originalValue: 100% name: Percentage1 phType: Percentage - value: USD 5,500,000 originalValue: USD 5,500,000 name: DefinedData0 phType: Amount tags: - Page:6A45CE72-A1D1-4270-B767-0DDAF5FF0735 - Premium_Amount - value: annual originalValue: annual name: DefinedData1 phType: DefinedData tags: - Page:6A45CE72-A1D1-4270-B767-0DDAF5FF0735 - Premium_Period_Qualifier elements: - index: 0 text: ' [[DefinedData0]] ([[Percentage1]]) [[DefinedData1]]' tagPages: - pageID: 6A45CE72-A1D1-4270-B767-0DDAF5FF0735 sectionIDs: [] title: '' originalSection: '' subItems: [] index: 7 mrcHeading: Premium - fragments: [] originalHeading: 'INFORMATION ' nameVariation: NonMRCHeading mrcSection: Information placeholders: [] elements: [] originalSection: self index: 8 subItems: [] mrcHeading: NonMRCHeading - originalHeading: INFORMATION mrcHeading: Information nameVariation: Information locked: false mrcSection: Information placeholders: [] elements: - index: 0 text: '' index: 9 tagPages: - pageID: F479C70D-2059-417F-98F6-64F9F041BD37 sectionIDs: [] title: '' subItems: [] originalSection: '' fragments: [] - fragments: [] mrcHeading: NonMRCHeading nameVariation: NonMRCHeading mrcSection: SecurityDetails placeholders: [] index: 15 originalSection: self elements: [] subItems: [] originalHeading: 'SECURITY DETAILS ' - originalHeading: WRITTEN LINES mrcHeading: InsurersWrittenLine nameVariation: InsurersWrittenLine mrcSection: SecurityDetails placeholders: [] index: 16 originalSection: '' elements: - index: 0 text: In a co-insurance placement, following (re)insurers may, but are not obliged to, follow the premium charged by the lead (re)insurer. - index: 1 text: (Re)insurers may not seek to guarantee for themselves terms as favourable as those which others subsequently achieve during the placement. subItems: [] fragments: [] - originalHeading: 'SUBSCRIPTION AGREEMENT ' fragments: [] nameVariation: NonMRCHeading mrcSection: SubscriptionAgreement placeholders: [] index: 10 originalSection: self elements: [] subItems: [] mrcHeading: NonMRCHeading - fragments: [] mrcHeading: SlipLeader nameVariation: SlipLeader mrcSection: SubscriptionAgreement placeholders: [] index: 11 originalSection: '' elements: - index: 0 text: The Slip Leader is ENTER SLIP LEADER subItems: [] originalHeading: SLIP LEADER - originalHeading: BUREAU(X) LEADER(S) fragments: [] nameVariation: BureauLeader mrcSection: SubscriptionAgreement placeholders: [] index: 12 originalSection: '' elements: - index: 0 text: The Bureau(x) Leader(s) (where applicable) is AAA NNN subItems: [] mrcHeading: BureauLeader - fragments: [] originalHeading: 'FISCAL AND REGULATORY ' nameVariation: NonMRCHeading mrcSection: FiscalAndRegulatory placeholders: [] elements: [] index: 13 originalSection: self subItems: [] mrcHeading: NonMRCHeading - fragments: [] mrcHeading: NonMRCHeading nameVariation: NonMRCHeading mrcSection: BrokerRemunerationAndDeductions placeholders: [] index: 14 originalSection: self elements: [] subItems: [] originalHeading: 'BROKER REMUNERATION AND DEDUCTIONS ' /api/risks/{riskID}/declineFirmOrder: post: summary: Declines a firm order - Underwriter Only description: An underwriter may only decline a firm order before adding a written line. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The full unique ID of the firm order, ending in ::FO::{companyId}::{teamId}. Please make sure that the companyId and teamId are correct and relevant for the team you are declining for, as a broker may send a firm order on the same contract to multiple teams and/or Whitespace corporate accounts at your organisation. example: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL requestBody: description: Payload depends on the type of the contract and whether it is sectioned. See below for examples. required: true content: application/json: examples: Open Market/Facility: description: Open Market or Facility value: - {} Declaration: description: Declaration value: - associatedFacilityID: facilityID: ICE82100B0-2D8B-4DD5-883E-B3D2AC98DA81 Sectioned Open Market/Facility: description: Sectioned Open Market or Facility value: - sectionID: '1' Sectioned Declaration: description: Sectioned Declaration value: - sectionID: '1' associatedFacilityID: facilityID: ICE82100B0-2D8B-4DD5-883E-B3D2AC98DA81 schema: type: array items: type: object example: {} responses: '200': description: succesfully declined Firm Order content: application/json: example: - rev: 1-f1363da19c65a9928ecce76a74a63bb8 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL::ARCH::2E365330-46EB-4841-9ECC-431474D2BE8A - rev: 1-835f0c80fe9b8705f956a73a8d058320 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL::ACTI::5E35C3E8-2D61-4BB9-BD84-0A09723E87F1 - rev: 2-8d65daf913586207660d2570ee587970 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL::LGUS - rev: 3-b376e2514217166c2ae6de972d603db8 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL - rev: 1-335ee730cde9c14ab513ebdbf9e4a733 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FOD::TOMYUNDERWRITING::ALL /api/risks/{riskID}/withdrawFirmOrder: post: summary: Withdraw a firm order from an underwriter - Broker Only description: Retract a request for a written line. A firm order can only be withdrawn before the underwriter writes a line. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the firm order, starting with 'IC' and ending in '::FO' example: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO requestBody: description: The payload required varies by contract type and whether it is sectioned. See below for examples. required: true content: application/json: examples: Open Market/Facility: description: Unsectioned Open Market or Facility Agreement value: - channel: tomyunderwriting_ALL Sectioned Open Market/Facility: description: Sectioned Open Market or Facility Agreement value: - channel: tomyunderwriting_ALL sectionID: '1' Declaration: description: Unsectioned Declaration value: - channel: tomyunderwriting_ALL associatedFacilityID: facilityID: ICE82100B0-2D8B-4DD5-883E-B3D2AC98DA81 Sectioned Declaration: description: Sectioned Declaration value: - channel: tomyunderwriting_ALL associatedFacilityID: facilityID: ICE82100B0-2D8B-4DD5-883E-B3D2AC98DA81 sectionID: '1' schema: type: array items: type: object properties: channel: type: string responses: '200': description: successfully withdrew Firm Order content: application/json: example: - rev: 1-f1363da19c65a9928ecce76a74a63bb8 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL::ARCH::2E365330-46EB-4841-9ECC-431474D2BE8A - rev: 1-835f0c80fe9b8705f956a73a8d058320 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL::ACTI::5E35C3E8-2D61-4BB9-BD84-0A09723E87F1 - rev: 2-8d65daf913586207660d2570ee587970 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL::LGUS - rev: 3-b376e2514217166c2ae6de972d603db8 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FO::TOMYUNDERWRITING::ALL - rev: 1-335ee730cde9c14ab513ebdbf9e4a733 id: ICEB90F9F2-7B58-41FD-9160-528350E53EFE::FOD::TOMYUNDERWRITING::ALL /api/risks/{riskID}/saveVerticalLines: post: tags: - Risks summary: Sets the vertical terms for a specific heading on a risk. This operation can only be performed on contracts at the firm order or bindable quote stages - Broker Only parameters: - in: path name: riskID required: true schema: type: string description: The unique ID of the risk, starting IC and having parts delimited by '::' example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: description: Data specifying the vertical terms required: true content: application/json: examples: Insured - a simple case: description: A simple case of adding three vertical terms for the Insured heading with no tagged data value: verticalLines: - elements: - text: Acme Inc index: 0 placeholders: [] attributes: locked: false - elements: - text: Dalston Airways index: 0 placeholders: [] attributes: locked: false - elements: - text: Test Company index: 0 placeholders: [] attributes: locked: false initialLineIndex: 9 _rev: 8-d3238cf5840b5a334e53062cbaa06b1b Premium - Defined Data: description: A more complicated case involving Defined Data tags value: verticalLines: - elements: - text: '[[DefinedData0]]' index: 0 placeholders: - name: DefinedData0 value: GBP 10,500,000 phType: Amount tags: - Page:9FA04CFC-EE83-45F5-BD50-9581A63DE206 - Premium_Amount tagPages: - sectionIDs: [] title: '' pageID: 9FA04CFC-EE83-45F5-BD50-9581A63DE206 attributes: locked: false - elements: - text: '[[DefinedData0]]' index: 0 placeholders: - name: DefinedData0 value: GBP 13,500,000 phType: Amount tags: - Page:9FA04CFC-EE83-45F5-BD50-9581A63DE206 - Premium_Amount tagPages: - sectionIDs: [] title: '' pageID: 9FA04CFC-EE83-45F5-BD50-9581A63DE206 attributes: locked: false - elements: - text: '[[DefinedData0]]' index: 0 placeholders: - name: DefinedData0 value: GBP 15,000,000 phType: Amount tags: - Page:9FA04CFC-EE83-45F5-BD50-9581A63DE206 - Premium_Amount tagPages: - sectionIDs: [] title: '' pageID: 9FA04CFC-EE83-45F5-BD50-9581A63DE206 attributes: locked: false initialLineIndex: 11 _rev: 1-74afa924b92ada72344dc7d1b219e0b4 schema: properties: _rev: type: string description: the current revision of the risk document example: 3-7984cfdf73dfca82ccd1178ec066b005 initialLineIndex: type: number description: the index number of the line item for the heading that is receiving vertical terms example: 6 verticalLines: type: array items: type: object properties: attributes: type: object properties: locked: type: boolean description: true if the item is to be locked, ie not editable by the underwriter example: false elements: type: array description: the text of the vertical terms items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/elements/items' tagPages: type: array description: the data tag pages identifying the Defined Data sets associated with the terms. Can be empty items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/tagPages/items' placeholders: type: array description: the data value placeholders used in the line item items: $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1editLineItem/post/requestBody/content/application~1json/schema/properties/placeholders/items' responses: '200': description: successful response content: application/json: schema: $ref: '#/components/schemas/RWPlacing' '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/notTakeUpQuotation: post: tags: - Risks summary: Mark a quote recieved from an underwriter as NTU (Not Taken Up) - Broker Only parameters: - in: path name: riskID required: true schema: type: string description: The unique ID of the quote, starting IC and ending with '::UQ#', where example: IC13FD54AD-2DAA-49C2-A91C-E5DCEE3BFCE2::MU999AF919-3FDB-49F2-B4C5-D42614B02E70::UQ4 requestBody: description: POST an empty object required: true content: application/json: schema: type: object description: empty payload responses: '200': description: successful response content: application/json: schema: type: object properties: msg: example: doc with id IC13FD54AD-2DAA-49C2-A91C-E5DCEE3BFCE2::MU999AF919-3FDB-49F2-B4C5-D42614B02E70::UQ2 successfully not taken up '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/rollbackSigned: post: summary: Reverts a risk from signed to unsigned - Broker Only description: Removes the 'signed' status from the contract's written lines, reverting the contract back to the written firm order stage. No other changes are made. It is NOT possible to roll back the signed status of a facility agreement contract once a declaration has been shown to it. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the signed contract document, starting IC and ending in '::SIGNED' example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854::SIGNED requestBody: description: Please add an empty payload of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: successfully rolled back signed lines content: application/json: schema: type: object properties: msg: type: string example: Signed risk rolled back to Firm Order. description: A message indicating success /api/risks/{riskID}/createEndorsement: post: summary: Creates an endorsement - Broker Only description: Can only create an endorsement on a risk at the Signed or Firm Order stages. In the case of Firm Order, at least one line must have gone down. It is currently not possible to create Mid-Term Participant Change endorsements on risks with vertical terms. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Firm Order/Signed Risk example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854::SIGNED requestBody: required: true content: application/json: schema: type: object properties: number: type: number example: 1 description: The number of the endorsement you want to create. Cannot duplicate the number of an already-exisitng endorsement. type: type: string example: standard description: The type of endorsement - standard refers to a normal endorsement, mtpc refers to a Mid-Term Participant Change endorsement. enum: - standard - mtpc responses: '200': description: successfully created Endorsement content: application/json: schema: type: object properties: msg: type: string example: Created endorsement with docID ICE82100B0-2D8B-4DD5-883E-B3D2AC98DA81::SIGNED::EN2 docID: type: string example: ICE82100B0-2D8B-4DD5-883E-B3D2AC98DA81::SIGNED::EN2 description: the ID of the newly created Endorsement version: type: string example: '2.8' /api/risks/{riskID}/deleteDraft: post: summary: Deletes a Draft Contract - Broker Only tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Draft. example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854 requestBody: description: Please add an empty object of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: successfully deleted draft content: application/json: schema: type: object properties: msg: type: string example: Draft Deleted description: A message indicating success /api/risks/{riskID}/applyTemplate: post: tags: - Risks summary: Merge the data from a risk with the text, data and other material from a template, preserving all the risk''s data while replacing all its other content - Broker Only description: You need the ID and current revision number of both the risk and the template you are trying to merge. You can fetch the revision number of a risk with /risks/{riskID} and check the ._rev field. Can only be done on a risk stage that has not been shown to underwriters. parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 requestBody: content: application/json: schema: properties: templateID: type: string description: The unique ID of the template example: IC4E211C90-FA0D-4B87-83CD-7F35CC443D9C contractRev: type: string description: Revision of the contract example: 2-779b4a910939f5f5fb2196edc7aa854a templateRev: type: string description: Revision of the template example: 6-4ace697891baf963c4ccc5961623e292 responses: '200': description: successful response content: application/json: schema: properties: rev: description: Revision of the new risk example: 10-849b76541bfc6683d15208ea4ebe43c5 type: string ok: type: boolean example: true id: type: string example: IC9326FED7-A802-4C86-B625-6E078470CA83 description: ID of the merged risk '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/rejectWrittenLine/{writtenLineSetID}: post: tags: - Risks summary: Reject an underwriter''s line written with Line Conditions or Subjectivities - Broker Only description: You need to provide the ID of the Firm Order as well the ID of the underwriter''s line (RWWrittenLineSet ID). This can be fetched from /combinedSets, /getExtendedRisk parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Firm Order example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO - in: path name: writtenLineSetID schema: type: string required: true description: The unique ID of the RWWrittenLineSet which can be retrieved from /combinedSets example: IC8BEBB532-E007-453C-9A6F-EC227AEF6B85::FO::TOMYUNDERWRITING::ALL::WRLS requestBody: content: application/json: schema: type: object responses: '200': description: successful response content: application/json: schema: properties: msg: description: A msg indicating success example: Successfully rejected line type: string '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/acceptWrittenLine/{writtenLineSetID}: post: tags: - Risks summary: Accepts an underwriter''s line with Line Conditions or Subjectivities - Broker Only description: You need to provide the ID of the Firm Order as well the ID of the underwriter''s line (RWWrittenLineSet ID). This can be fetched from /combinedSets, /getExtendedRisk. parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Firm Order example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO - in: path name: writtenLineSetID schema: type: string required: true description: The unique ID of the RWWrittenLineSet which can be retrieved from /combinedSets example: IC8BEBB532-E007-453C-9A6F-EC227AEF6B85::FO::TOMYUNDERWRITING::ALL::WRLS requestBody: content: application/json: schema: type: object description: Empty Payload responses: '200': description: successful response content: application/json: schema: properties: msg: description: A msg indicating success example: Successfully accepted line type: string '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/createContractCorrection: post: summary: Create a Contract Correction - Broker Only description: A Contract Correction can only be started at the Signed stage or at Firm Order if at least one written line is present and no line requests are outstanding. Other outstanding Actions will prevent correction, including (but not limited to) a line written with a subjectivity response that has not been agreed/rejected, an incomplete endorsement, an outstanding line removal request, and other unresolved contract-altering issues. tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Firm Order or Signed Risk example: IC63D86D53-3B1F-459F-9D35-5C2D4F0E4854::FO requestBody: description: Please add an empty object of {} required: true content: application/json: schema: type: object description: Empty Payload responses: '200': description: successful response content: application/json: schema: type: object properties: msg: type: string example: Contract Correction Created description: A message indicating success /api/risks/{riskID}/contractAttributes: post: tags: - Risks summary: Edit an attribute of the entire contract. Currently limited to text-locking options - Broker Only description:You can use this call to record a line for an off-platform company on 'FullContracts' OR for an off-platform team of a live company on an off-platform contract.
You can use an existing stamp or, for an off-platform carrier, create a new stamp yourself. If you want to use an existing stamp for an off-platform carrier, you can grab the list of existing stamps by calling /documents/{docID}, where docID in this case is Extra-{companyId}.
Always set saveStamps as False.
There are number of stamp types you can choose but for now via API we are only allowing nonBureau stamps. See example below
parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Firm Order or Bindable Quote example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::FO requestBody: content: application/json: examples: Non Bureau Stamp: description: Non-bureau stamp value: _rev: 2-e61bf2c6aa5ff799b4e4e17b57c003ee items: - lines: - sectionIDs: [] impressions: - references: - reference: AFFFFF riskCodes: '' writtenPercentage: '12' stampID: '' bureauMarket: '' businessUnit: Non Bureau MGA Example bureauMarketCode: '' bureauSubMarket: '' stampType: other shortName: Non Bureau 5123 category: NonBureauMGA splitStampData: - code: '61232131' pseudonym: '' coverholder: false conditions: lineConditions: [] subjectivities: [] leadUnderwriter: false writtenDate: 1748003486 uwrChannel: offlineberkshirehathaway_ALL saveStamps: true schema: type: object properties: _rev: type: string example: 2-7066db9d64dbbe1dbf2a531bd33bf631 items: type: array items: type: object properties: lines: type: array items: type: object properties: sectionIDs: type: array items: type: string example: 1 impressions: type: array items: type: object properties: references: type: array items: type: object properties: reference: type: string example: DSFSDFSDF riskCodes: type: string example: '' writtenPercentage: type: string example: '100' stampID: type: string example: ST610A6AE7-A17F-47DE-9894-42B16B843733 bureauMarket: type: string example: Lloyd''s businessUnit: type: string example: Lloyd''s Underwriter Syndicate No. 6543 BLE bureauMarketCode: type: string example: '6543' bureauSubMarket: type: string example: '' stampType: type: string example: lloyds shortName: type: string example: '' mirrorStampsData: type: array items: type: object properties: references: type: array items: type: string example: FSDFSDF businessUnit: type: string example: Blenheim Underwriting Limited bureauMarket: type: string example: XIS bureauMarketCode: type: string example: B1234 bureauSubMarket: type: string example: '' stampID: type: string example: ST4F172B8C-4860-49A3-B140-A17B804D220A stampType: type: string example: other shortName: type: string example: '' mirrorStampCustomDescription: type: string example: Custom conditions: type: object properties: lineConditions: type: array items: {} description: details of any line conditions subjectivities: type: array items: {} description: details of any no deadline subjectivities leadUnderwriter: type: boolean description: are they the lead underwriter or not writtenDate: type: integer example: 1747654790 description: Date in unix epoch time uwrChannel: type: string example: offlineblenheimsyndicate_ALL saveStamps: type: boolean description: Choose whether to save a stamp. Only works for off-platform entities. responses: '200': content: application/json: schema: type: object properties: msg: type: string /api/risks/{riskID}/forwardAsQuoteRequest: post: summary: Forwards a quote as a new quote request - Broker Only tags: - Risks parameters: - in: path name: riskID schema: type: string required: true description: The ID of the quote to forward. The POST payload has several optional parameters -- 'userId' specifies the uniqueID of a specific user to show the draft to, 'messages' includes a broker''s message with the contract, and 'attachments' identifies attachments to share with the request. example: ICD57AF686-6EB7-4D6B-A43A-5978F2C2681F::MU999AF919-3FDB-49F2-B4C5-D42614B02E70::UQ1 requestBody: content: application/json: schema: type: object properties: teamId: type: string description: The carrier team to send the quote request to. All uppercase, no spaces example: MARINEHULL companyId: type: string description: The carrier company to send the quote request to. All uppercase, no spaces example: WHITECLIFFS userId: type: string description: Optional -- include the MU identifier of an individual underwriter to send the quote request to them specifically example: MUD10D799A-7AEB-4F84-A4D9-9FDA73D057DE facilityID: type: string description: Required if the risk is a declaration. Specifies the facility agreement that the quote request is being shown under. example: ICCDA7C650-47DB-40E5-B8C0-588867E6BB6D messages: type: array description: Optional -- include to send an accompanying broker''s message items: type: object properties: channel: type: string description: The receipient''s channel ID example: whitecliffs_MARINEHULL elements: type: array items: type: object properties: text: type: string example: Please agree description: The body of the message index: type: integer example: 0 greeting: type: string example: Hello description: The header text of the message closing: type: string example: Best regards description: The footer text of the message attachments: type: array description: Optional -- include to specify the attachment/s to share along with the quote request items: type: object properties: attachID: type: string example: A-77C8A342-DCDA-410B-9292-B3CD3105FC10 description: The ID of the attachment docID: type: string example: IC2B5E02ED-FF47-4BB6-98F5-8C85F1E052B5::ATCH::A-77C8A342-DCDA-410B-9292-B3CD3105FC10 description: The unique ID of the attachment document channels: type: array items: type: string example: whitecliffs_MARINEHULL description: The channel of the recipient to share the attachment with responses: '200': description: successfully forwarded the quote request content: application/json: schema: type: object properties: msg: type: string example: Forwarded /api/risks/{riskID}/setEndorsementFollowerRoles: post: tags: - Risks summary: Set the roles of carriers on a Endorsement - Broker Only description: A role assigned to a carrier cannot be changed once they have been shown the endorsement. Only carriers who have added a line on the firm order can be assigned a role, but all those carriers must have a role assigned. parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Endorsement example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::SIGNED::EN1 requestBody: content: application/json: schema: type: array items: type: object properties: channel: type: string example: whitesails_MARINE description: the channel of the carrier type: type: string description: the role to assign example: leader enum: - leader - agreementParty - doesNotApply - notifyParty - nonNotifyParty responses: '200': description: successful response content: application/json: schema: type: array items: type: object properties: rev: type: string description: the new revision of the document that was updated example: 5-79fc84132c7b0d9df26daecc84c21de9 id: type: string description: the id of the document that was updated example: IC6FD42DF7-989A-4AB4-8638-1EB5870E70CD::SIGNED::EN3::ENF::offlineallianzglobal_ALL /api/risks/{riskID}/setEndorsementFollowerTemplate: post: tags: - Risks summary: Set the agreement template for an endorsement - Broker Only description: Choose between GUA - Marine (GUAStampA), GUA - Non Marine (GUAStampB), AVS100B - Aviation (AVS100B) and non-GUA (NonGUA). Can only be set once the Endorsement has been assigned a Leader. parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the endorsement example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::SIGNED::EN1 requestBody: content: application/json: schema: type: object properties: channel: type: string example: whitesails_MARINE description: the channel of the leader template: type: string description: the type of agreement template for the endorsement example: GUAStampA enum: - GUAStampA - GUAStampB - AVS100B - NonGUA responses: '200': description: successful response content: application/json: schema: type: object properties: endorsementDocID: type: string example: ICC158D6C8-C9E7-4E2C-BAD2-3AA77781CF13::FO::EN4 provenance: type: object properties: version: type: string example: 2025-05-22@11:41:11 dataHash: type: string example: 392ccf6c3b8bcba72027b4fbb0882aab74579063a9132b269803fa612f4c14ab provHash: type: string example: 54c906ca1b32c13e33224580e562b20752576a1becaa97df48d21a396ebdfa34 system: type: string example: LaVAPI writtenAt: type: string example: '2025-05-23 08:50:29' userID: type: string example: MU9FCFC64E-7694-420A-BE61-2ABEDB3E8F52 updatedAt: type: string example: '2025-05-23 08:50:29' _rev: type: string example: 9-ff211010ac83c76c5f76b31b2f87a3e6 createdAt: type: string example: '2024-06-11 11:11:46' version: type: integer example: 21700 template: type: string example: GUAStampB uwrChannel: type: string example: offlinearielrebda_ALL channels: type: array items: type: string example: - akhil_ALL - offlinearielrebda_ALL type: type: string example: RWEndorsementFollower _id: type: string example: ICC158D6C8-C9E7-4E2C-BAD2-3AA77781CF13::FO::EN4::ENF::offlinearielrebda_ALL followerType: type: string example: unchosen '401': $ref: '#/paths/~1api~1risks~1save/post/responses/401' /api/risks/{riskID}/completeEndorsement: post: tags: - Risks summary: Complete a Endorsement and bind any notify parties to it - Broker Only description: This endpoint can only be used once the Leader and any agreement parties on the endorsement (if they exist) have agreed to it. The normal payload accompanying the endorsement ID is just a blank object, but it can be used to share attachments with notify parties. parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the Endorsement example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57::SIGNED::EN1 requestBody: content: application/json: schema: type: object properties: attachments: type: array items: type: object properties: docID: type: string example: IC6FD42DF7-989A-4AB4-8638-1EB5870E70CD::ATCH::A-68FDB77D-B32B-40CB-A6CC-258544DB0502 description: the docID of the attachment attachID: type: string description: the attachmentID of the attachment example: A-68FDB77D-B32B-40CB-A6CC-258544DB0502 channels: type: array description: the channels of the notify parties to share the attachment with items: type: string example: whitesails_ALL responses: '200': description: successfully completed Endorsement content: application/json: schema: type: object properties: msg: type: string example: Endorsement Completed description: a message indicating success components: schemas: ExtendedMRC: type: object description: JSON returned by getExtendedMRC including the Risk and a broader range of data properties: createdAt: type: string example: '2021-08-04T15:18:02.000Z' updatedAt: type: string example: '2021-08-04T15:18:02.000Z' type: type: string example: RWPlacing description: RWPlacing in all cases control: $ref: '#/components/schemas/RWPlacing/properties/control' channels: type: array items: type: string example: ajc_ALL MRCContract: $ref: '#/components/schemas/RWPlacing/properties/MRCContract' questionnaire: type: object properties: questionnaire: type: object properties: questions: type: array items: type: object properties: tag: type: string example: Pension_Or_Benefits_Plan_Company_Sponsor description: name of the tag text: type: string example: Does the company sponsor any pension or benefits plan? description: The Question text id: type: string example: Pension or Benefits Plan - Company Sponsor description: the id of the question hidden: type: boolean example: true description: If the question is hidden or not, usually because the dependant question has not been answered table: type: array items: type: object properties: tag: type: string example: Asset_Amount_Year text: type: string example: Year required: - tag - text required: - text - id - tag required: - questions required: - questionnaire proposedEndorsementFollowers: type: object description: an object where the keys are the carrier team ids and the values are 'unchosen', 'leader', 'agreementParty', 'notifyParty', 'nonNotifyParty' properties: palermo_ALL: description: as an example, the follower status for the Palermo All Risks team type: string example: leader provenance: type: object description: Meta-data about the document to aid with auditing properties: version: type: string description: Version message of the platform system that created the document example: 2022-04-11@15:04:48 dataHash: type: string description: Data hash of the activity document example: 485241de4e5bfc76a0e2ef8bab79350c02d3aa06846fd2996cbf9fc9a7840eb0 system: type: string description: The internal name of the platform system example: LavAPI userID: type: string description: The user ID of the user whose action generated the document example: MUB980AB60-1C96-4092-A1B4-B8FB183360D1 writtenAt: type: string description: The creation date of the document, in YYYY-MM-DD hh:mm:ss format example: '2022-05-09T11:44:41.000Z' provHash: type: string description: Provisioning hash of the document example: 76a209a16d8b9214e7a33483d78718cc1a7e7aed7047282d2c94417404558e2d accountDocID: type: string example: '' writtenLineSets: type: array description: the written lines on the contract items: $ref: '#/components/schemas/RWWrittenLineSet' signedLineSets: type: array description: the signed lines on the contract items: $ref: '#/components/schemas/RWSignedLineSet' platformReferences: type: object description: document and revision of the risk properties: RiskID: type: string description: the document ID of the risk example: IC08B5EC17-5486-4323-82FC-62CC8C410EA0::FO::EN1 Revision: type: string description: the revision of the risk example: 4-b63141573da07d5316b7a2b4585fbd2b RWQuotedLine: type: object properties: _id: type: string example: ICD0645233-E126-4768-AB15-0A8828F5F08C::BQ1::TOMYUNDERWRITING::ALL::BQL description: The unique ID of this document _rev: example: 1-087952cf08f44dae740c1c001e2d5ab2 type: string description: The revision number of this document channels: type: array items: type: string example: akhil_ALL description: The team IDs of the users who can see the risk createdAt: type: string example: '2024-02-21 15:05:47' description: The creation time of this document line: type: array items: type: object description: The data for the line (Signed/Written/Quoted) properties: version: type: number example: 1 description: Version number sectionIdentifiers: type: array description: The section/s of the risk to which the line is attached items: type: string example: '2' description: The ID number of the section businessUnit: type: string example: Catania Insurers Ltd description: The business unit of the underwriter who put down the line stampedAt: type: string description: The date and time when the line was put down example: '2019-10-01 09:31:43' subjectivities: type: array description: Details of any subjectivities added by the underwriter items: type: object properties: approvedStatus: type: string enum: - notYetResponded - accepted - rejected - deadlineExpired description: Current status of the broker's response to the underwriter's subjectivity deadline: type: string example: '1708560000.0' description: The deadline for accepting the subjectivity response in unix epoch time identifier: type: string example: 59F40DB9-557C-46F6-95A0-179270BD5A44 description: The uniqueID of the subjectivity text: type: string example: Sample Subjectivity description: Text detailing the requirement of the subjectivity subjectivityMode: type: string enum: - unchosen - holdingCover - noCoverGiven description: Whether this line provides cover whilst the subjectivity is being agreed subjectivitiesDeadlineNotRequired: type: string description: Details of any Subjectivites with no deadlines canUpdateConditions: type: boolean example: true description: Can line conditions be updated? stamperChannel: type: string description: The team channel of the underwriter who put down the line example: catania_ALL stamperEmail: type: string example: underwriter.messina@wspt.co.uk description: The email address of the underwriter who put down the line stamperName: type: string description: The name of the underwriter who put down the line example: Charles Messina role: type: string description: The facility participation role of the underwriter enum: - leader - agreementParty - notifyParty - nonNotifyParty - doesNotApply contractArchiveID: type: string description: The unique ID of the archived version of the risk document at the moment the line was put down example: IC9642312E-D0E2-46FE-8B08-9C3002C1DEC9::FO::CATANIA::ALL::ARCH::5A734DCC-98CC-4C41-A42F-3A43A5E44EE0 toStand: type: boolean description: Whether the underwriter has marked the line To Stand, i.e. it may not be signed down example: true impressions: type: array description: Each item in the array represents an inked stamp detailing the line being put down. items: type: object properties: riskCodes: type: array items: type: object properties: code: type: string example: H3 description: The risk code allocated to the written line index: type: string description: The index order of the risk code example: '0' signedLinePercentageString: type: string description: The line percentage signed by the broker, which may be less than the underwriter's written line for SignedLineSets example: '44.0272' writtenLinePercentageString: type: string description: The line percentage written by the underwriter example: '45' uwRefs: type: array items: type: string description: The reference code assigned by the underwriter, which in many stamp types is limited to 12 alphanumeric characters example: FHSDJFSDHFSD descriptions: type: array items: type: string tiltAngleString: type: string description: The display angle used when rendering the stamp on the screen or printed page, used to give the appearance of manually stamped paper example: '0.04264535201250923' yearOfAccount: type: string example: '2024' description: The year of account for the contract, if the stamp has been put down by the contract leader stamp: $ref: '#/components/schemas/CorporateDetail/properties/stamps/items' stampIdentifiers: type: array items: properties: category: type: string description: The originating market or other authority that the stamp is put down under example: LloydsSyndicate categoryNumber: type: string description: The unique identifier of the capacity in the market, for example a bureau market code, Lloyds Syndicate Number, DUNS number, or other identifier example: '1314' categoryExtra: type: string description: The three-letter pseudonym of the Lloyd's of London or Lloyd's Brussels Syndicates that the underwriter belongs to, if any example: ASC splitPercentage: type: string description: If the stamp has been marked by the underwrite as split, this lists the line percentage falling under this particular syndicate or capacity. Split stamps have a separate stampIdentifiers array for each syndicate, and the combined splitPercentage values of all arrays in the split totals 100% example: 82% pseudonymn: type: string description: the pseudonymn used to identify the stamp coverholder: type: boolean example: false description: Whether the stamp is for a consortium brexitData: type: array description: Defunct from version 2.18. This array used to appear if the line bore an EEA mirror stamp. items: type: object properties: stamp: $ref: '#/components/schemas/CorporateDetail/properties/stamps/items' references: type: array items: type: string description: The reference code assigned by the underwriter, which in many stamp types is limited to 12 alphanumeric characters example: FHSDJFSDHFSD descriptions: type: array items: type: string description: Any extra description added for the mirror stamp example: This is a Description customDescription: type: string example: Applying to EEA description: Text appearing at the top of the mirror stamp stampIdentifiers: type: array items: properties: category: type: string description: The originating market or other authority that the stamp is put down under example: LloydsSyndicate categoryNumber: type: string description: The unique identifier of the capacity in the market, for example a bureau market code, Lloyds Syndicate Number, DUNS number, or other identifier example: '1314' categoryExtra: type: string description: The three-letter pseudonym of the Lloyd''s of London or Lloyd''s Brussels Syndicates that the underwriter belongs to, if any example: ASC splitPercentage: type: string description: If the stamp has been marked by the underwriter as split, this lists the line percentage falling under this particular syndicate or capacity. Split stamps have a separate stampIdentifiers array for each syndicate, and the combined splitPercentage values of all arrays in the split totals 100% example: 82% pseudonymn: type: string description: The pseudonymn used to identify the stamp coverholder: type: boolean example: false description: Whether the stamp is for a consortium mirrorStamps: type: array description: This array only appears if the line bears one or more mirror stamps items: type: object properties: stamp: $ref: '#/components/schemas/CorporateDetail/properties/stamps/items' references: type: array items: type: string description: The reference code assigned by the underwriter, which in many stamp types is limited to 12 alphanumeric characters example: FHSDJFSDHFSD descriptions: type: array items: type: string description: Any extra description added for the mirror stamp example: This is a Description customDescription: type: string example: Contiguous 48 States only description: Text appearing at the top of the mirror stamp stampIdentifiers: type: array items: properties: category: type: string description: The originating market or other authority that the stamp is put down under example: LloydsSyndicate categoryNumber: type: string description: The unique identifier of the capacity in the market, for example a bureau market code, Lloyd''s Syndicate Number, DUNS number, or other identifier example: '1314' categoryExtra: type: string description: The three-letter pseudonym of the Lloyd''s of London or Lloyd''s Brussels Syndicates that the underwriter belongs to, if any example: ASC splitPercentage: type: string description: If the stamp has been marked by the underwriter as split, this lists the line percentage falling under this particular syndicate or capacity. Split stamps have a separate stampIdentifiers array for each syndicate, and the combined splitPercentage values of all arrays in the split totals 100% example: 82% pseudonymn: type: string description: The pseudonymn used to identify the stamp coverholder: type: boolean example: false description: Whether the stamp is for a consortium contractHash: type: string example: 81b7151e30ba40f098ab50cc3828e5ff6f5a725dbb76910416f018d3ca23638a description: A hash of the contract data to verify the text being agreed to stamperUserID: type: string example: MUB6090366-B15D-4C2B-BA54-EABE5F638FDF description: The unique User ID of the underwriter conditionsEnabled: description: Whether conditions were attached to the written line type: boolean example: true mode: type: string example: quoted associatedFacilityId: type: string example: IC49BB5707-698B-4E51-B3C0-85FA763B94CC description: The unique ID of the facility agreement that the declaration is attached to associatedFacilitySectionID: type: string example: '1' description: The ID number of the section of the facility agreement that the declaration is attached to validityPeriod: type: string example: 60 Days description: The validity period of the quote in days (only for quoted lines) lineConditions: type: array description: The set of line conditions added by the underwriter items: type: string example: Line To stand conditionsApproved: type: boolean description: Whether the added line conditions have been agreed to by the broker example: true provenance: $ref: '#/components/schemas/ExtendedMRC/properties/provenance' type: type: string description: The named JMRC type descriptor for this document example: RWQuotedLine updatedAt: type: string description: The date and time that this document was last updated example: '2024-02-21 15:05:47' isOffline: type: boolean example: true description: Whether the line is assigned to an offline carrier. parentDocID: type: string example: ICD0645233-E126-4768-AB15-0A8828F5F08C::BQ1::TOMYUNDERWRITING::ALL description: The unique ID number of the related RWPlacing document required: - _id - _rev - channels - createdAt - line - parentDocID - provenance - type - updatedAt RWWrittenLineSet: type: object properties: _id: type: string example: ICD0645233-E126-4768-AB15-0A8828F5F08C::FO::TOMYUNDERWRITING::ALL::WRLS description: The unique ID of this document _rev: example: 1-087952cf08f44dae740c1c001e2d5ab2 type: string description: The revision number of this document channels: type: array items: type: string example: akhil_ALL description: The team IDs of the users who can see the risk createdAt: type: string example: '2024-02-21 15:05:47' description: The creation time of this document contents: type: array items: $ref: '#/components/schemas/RWQuotedLine/properties/line/items' provenance: $ref: '#/components/schemas/ExtendedMRC/properties/provenance' type: type: string description: The named JMRC type descriptor for this document example: RWWrittenLineSet updatedAt: type: string example: '2024-02-21 15:05:47' description: The date and time that this document was last updated isOffline: type: boolean example: true description: Whether the stamp is associated with an offline carrier parentDocID: type: string example: ICD0645233-E126-4768-AB15-0A8828F5F08C::FO::TOMYUNDERWRITING::ALL description: The unique ID number of the related RWPlacing document required: - _id - _rev - channels - createdAt - line - parentDocID - provenance - type - updatedAt CorporateDetail: type: object properties: admins: type: array description: List of user emails for administrators at the company items: type: string example: sarah.kay.blackpool@wspt.co.uk updatedAt: type: string description: The date and time the company's details were last updated example: '2020-02-24T15:32:50.000Z' teams: type: array items: type: object properties: teamId: type: string description: Team identifier using uppercase letters with no punctuation example: MARINECARGO secondApprovalReviewers: type: array items: type: string description: Deprecated (see permissions array below). This array will always be empty. Formerly held userIDs of users with Internal Reviewer permission example: '-' secondApprovalSelfApprovers: type: array items: type: string description: Deprecated (see permissions array below). This array will always be empty. Formerly held userIDs of users with Self-Approver permission example: '-' name: type: string description: The name of the team, usually relating to the class of business worked on example: Marine Cargo channel: type: string description: The system channel for the team, comprising a lowercase version of the company ID, followed by underscrore and the team id example: blackpool_MARINECARGO isInactive: type: boolean example: false description: True if the team has been marked as inactive classOfBusiness: type: array items: type: string example: Marine description: The class(es) of business that are associated with the team createdAt: type: string description: Time and date of creation example: '2020-02-24 15:32:50' companyId: type: string description: Company identifier using uppercase letters with no punctuation example: OFFLINEBRITISHMARINE isTestOnly: type: boolean description: True if the company account is just a test account with no live database access example: false channels: type: array description: Array with just one item, shared channel items: type: string description: The value 'shared' example: shared stamps: type: array description: For (re)insurers, lists the stamps they have set up on the system. Empty for brokers items: type: object properties: bureauMarket: type: string example: Lloyd's bureauMarketCode: type: string example: '1444' bureauSubMarket: type: string example: PSM1 businessUnit: type: string example: Lloyd's Syndicate No.1444 stampType: type: string example: lloyds uniqueID: type: string example: ST1843A345-1F69-435D-84E9-187BB3DD0F23 buttonStamps: type: object properties: active: type: boolean example: true description: True if the button stamp is available for users to apply bureauMarketCode: type: string example: 5307/5 companyName: type: string example: Tomy iconOnStamp: type: boolean description: True if an icon of any type is shown on the stamp, icon type is specified by stampType example: true layout: type: object description: The placement of name, type, and code data on the button stamp, each appearing once across the bottom, center, and top slots of the stamp properties: bottom: type: string enum: - name - type - code center: type: string enum: - name - type - code top: type: string enum: - name - type - code stampID: type: string example: BTN-BAB19551-5557-4E6B-888B-E3B1B6A0E982 description: The unique ID of the button stamp, which always starts with BTN stampType: type: string description: The type of icon displayed on the stamp. Note that other indicates no icon enum: - lloyds - brexit - other settings: type: object properties: canViewOfflineTeams: type: boolean description: True if the broking organisation is configured to save off-platform lines example: false mandatoryAuthStages: type: array items: type: string description: The list of contract stages at which second approval is required before a contract can proceed example: brFirmOrder digitiseOnlyToTemplate: type: boolean example: true description: True if the broking organisation can only digitise imported contract files as templates isOffline: type: boolean description: True for company accounts that are offline placeholders for organisations not yet using the platform example: false _id: type: string description: Reference ID for this company document example: Corporate-BLACKPOOL _rev: type: string description: Currect revision ID for this document example: 3-a1df22093d0dc2978b87f396be3cd2fa name: type: string description: The name of the company example: Blackpool Insurance Brokers Ltd role: type: string description: The organisation's role on the platform, either 'broker' or 'underwriter' example: underwriter authorityDetails: type: array items: type: object properties: authority: type: string example: Lloyd's (Syndicate Number) pseudonymn: type: string example: '131' registrationNumber: type: string example: '12313' members: type: array items: type: object description: A user on the platform properties: name: type: string description: the user's name example: Sarah Kay email: type: string description:email address for the user
Note that for Data Protection reasons, the email is removed from some outputs, such as the /api/shared/corporate list. In these cases it can be removed by a call to /api/documents/Corporate-{CompanyID}.
example: sarah.kay.blackpool@wspt.co.uk currentState: type: string description: Live, Draft, Suspended etc example: Live uniqueID: type: string description: Live, Draft, Suspended etc example: MUDA8AF5A8-98DF-4EF2-B2B8-4E069EDB7E8C allowReporting: type: boolean description: whether or not the user may run the management reports example: true isOffPlatform: type: boolean description: indicates the user is "off platform"s example: false teams: type: array items: type: string description: list of teams the user belongs to example: - blackpool_MARINEHULL - blackpool_MARINECARGO permissions: type: object properties: secondApprovalReviewers: type: object properties: teams: type: object properties: teamID: type: array description: PLEASE NOTE the key-value of teamID above is just an indicative placeholder and will in practice be the teamID of one of the organisation's teams items: type: string example: MU6E391615-CFF5-4E8E-B9D2-B0DE03BACA0 description: The list of userID's of the team's members with Internal Reviewer permission secondApprovalSelfApprovers: type: object properties: teams: type: object properties: teamID: type: array description: PLEASE NOTE the key-value of teamID above is just an indicative placeholder and will in practice be the teamID of one of the organisation's teams items: type: string example: MU6E391615-CFF5-4E8E-B9D2-B0DE03BACA0 description: The list of userID's of the team's Internal Reviewers who also have the Self Approver permission templateManagers: type: object properties: teams: type: object properties: teamID: type: array description: PLEASE NOTE the key-value of teamID above is just an indicative placeholder and will in practice be the teamID of one of the organisation's teams items: type: string example: MU6E391615-CFF5-4E8E-B9D2-B0DE03BACA0 description: The list of userID's of the team's members who have the Template Manager permission. This permission is only available to broking organisations channelPrefix: type: string description: A lowercase version of companyId used for the beginning of team channels example: blackpool provenance: $ref: '#/components/schemas/ExtendedMRC/properties/provenance' RWPlacing: type: object description:The MRCRisk obect contains the full text and structure of the JMRC Insurance Contract.
It includes an MRCContract object where a set of MRCLineItem objects represent the headings and data in the contract, and an MRCRiskControl object which provides summary and meta data about the risk to enable the system's performance.
properties: _id: type: string example: IC213DA609-D6B5-4A05-86B8-3FD91E861F57 description: unique document id for the risk _rev: type: string example: 1-141df67df9e5eaacd0830c65e47a0bf9 createdAt: type: string example: '2021-08-04T15:18:02.000Z' updatedAt: type: string example: '2021-08-04T15:18:02.000Z' type: type: string example: RWPlacing description: RWPlacing in all cases control: type: object properties: status: type: string description: The current stage of the contract in the placing process, taken from an enumerated list containing stages such as Draft, Quoted, FirmOrder, etc example: FirmOrder insuranceType: type: string example: Insurance description: Either Insurance or ReInsurance, as specified at contract creation umr: type: string description: The Lloyd's Unique Market Reference number for the contract example: B0999JC201909241622 insuredName: type: string example: Acme Widgets Inc description: The name given to the contract contractType: type: string example: Aviation Hull Cover description: The class of business that the contract falls under leadUnderwriterChannel: type: string example: messina_ALL description: The team channel name of the lead underwriter on the risk, once specified leadUnderwriter: type: string example: Messina All Risks description: The plaintext company and team name of the lead underwriter's team, once specified placingBrokerChannel: type: string example: ajc_ALL description: The team channel name of the contract's broker placingBroker: type: string example: AJC All Risks description: The plaintext company and team name of the broker's team limitSummary: type: string description: The limit of liability for the contract originalDocID: type: string description: The unique ID of the document this contract was created from, if any example: IC97799647-4496-4760-B594-02AC726B0D7E endorsementNumber: type: string example: '2' description: If this contract is an endorsement, its endorsement number is stored here endorsementType: type: string description: For endorsements, specifies whether the endorsement is a Mid-Term Participant Change or a standard endorsement enum: - standard - mtpc isFacility: type: boolean example: false description: True if this contract is a facility agreement associatedFacilityIDs: type: array items: type: string example: ICB1213647-4876-4760-B594-02AC7261312412 description: If the contract is a declaration, this array lists the unique IDs of all facility agreeements it is attached to placementType: type: string enum: - FullContract - OffPlatform - Template description: The contract type. OffPlatform is for contracts backloaded to duplicate agreements conducted off-platform, Template is for contract templates, and FullContract is for all live contracts verticalVisibility: type: string enum: - OwnStampOnly - AllStamps - LeaderStamps description: If the risk has vertical terms, this string specifies which stamps underwriters can see. createdInVersion: type: number example: 21100 description: Which version of the platform the risk was created in. isIndicative: type: boolean example: false description: True if the Indicative flag been toggled, indicating that the contract is not binding. submittedAsCopyOf: type: string example: ICD937404C-87A7-4408-BE4B-D449216F9A85 description: If this contract is a placing document shared from another broker, the unique ID of the original producing broker's contract is held here. stampVisibility: type: string description: Decides whose stamps underwriters can see enum: - Allstamps - OwnStampsOnly - LeadersStamps MRCContract: type: object description: a top level object which currently contains only the array of line items properties: lineItems: type: array items: type: object $ref: '#/paths/~1api~1risks~1%7BriskID%7D~1lineitem~1%7BmrcHeading%7D/get/responses/200/content/application~1json/schema/items' channels: type: array items: type: string RWEndorsementFollower: type: object properties: _id: type: string description: Unique ID for this endorsement follower document example: IC4E49E958-870A-41B3-B60B-B5AAC51F48A5::SIGNED::EN1::ENF::messina_ALL _rev: type: string description: Revision number for this document example: 3-a1df22093d0dc2978b87f396be3cd2fa agreement: type: object properties: dateOfAgreement: type: string description: Effective date of the endorsement in yyyy-mm-dd hh:mm:ss format example: '2021-08-06 08:15:28' followerType: type: string example: leader description: The role of this follower in the endorsement enum: - leader - agreementParty - notifyParty - nonNotifyParty - doesNotApply - unchosen instruction: type: string example: leaderOnly description: The parties the broker has selected as needing to agree the endorsement enum: - leaderOnly - none - leaderAndAgreementParties - allToAgree leader: type: string example: 'Yes' description: Set to Yes when the underwriter that this document details is the leader of the endorsement numberOfDaysToNotifyFollowers: type: string description: The number of days within which non-Agreement followers must be notified of the endorsement example: '7' user: type: string example: MUE8368329-A451-49D4-A385-915D421A4465 description: The unique ID of the underwriter that this document details as a follower of the endorsement uwrChannel: type: string example: messina_ALL description: The team channel of the underwriter that this document details stampDescriptions: type: array items: type: object properties: stampID: type: string example: ST213211241241 description: The ID of the stamp that the follower put down on the endorsement desc: type: string example: 56 (added by Ascot Reinsurance Company Limited) description: The brief description text field of the stamp identified above mtpcAgreement: type: array items: type: object properties: type: description: If the endorsement is a mid-term participant change, this specifies the category of participant change enum: - add - modify - remove type: string line: $ref: '#/components/schemas/RWQuotedLine/properties/line/items' channels: type: array items: type: string description: A specific channel name identifying one of the entries in the array of team channels of the broker and all followers example: messina_ALL createdAt: type: string description: The date this document was created in yyyy-mm-dd hh:mm:ss format example: '2021-08-06 08:15:28' endorsementDocID: type: string example: IC4E49E958-870A-41B3-B60B-B5AAC51F48A5::SIGNED::EN1 description: The unique ID of the endorsement that this RWEndorsementFollower document is associated with followerType: type: string example: leader description: The participation type of the follower version: type: integer description: The integer portion of the _ver value, identifying the sequential version number of this document example: 3 type: type: string example: RWEndorsementFollower description: The JMRC document type of this document, which will always be RWEndorsementFollower updatedAt: type: string description: The date this document was last updated in yyyy-mm-dd hh:mm:ss format example: '2021-08-06 08:15:28' uwrChannel: type: string example: messina_ALL description: The team channel name of the follower's team template: type: string description: The category of agreement box displayed on the endorsement enum: - GUAStampA - GUAStampB - AVS100B - NonGUA mtpc: type: array items: type: object description: The details of the mid-term participant agreement, if the endorsement is of the MTPC type. Listed properties will change depending on whether the endorsement is adding, removing or modifying participants. properties: type: type: string enum: - add - remove - modify description: The type of change in participation sectionID: example: '1' description: The sectionID of the written line that is being modified/removed type: string setLeader: type: boolean example: true description: True if the MTPC is changing the leader guidance: type: object properties: conditionsEnabled: type: boolean example: true description: True if there are any conditions on the line guidance sectionIdentifiers: type: array items: type: string example: '1' description: The ID number of the section specifying the line guidance maxString: type: string example: '40' description: The maximum line percentage requested in the guidance minString: type: string example: '30' description: The minimum line percentage requested in the guidance suggestedStamps: $ref: '#/components/schemas/CorporateDetail/properties/stamps/items' role: description: The participation role of the follower type: string enum: - leader - agreementParty - notifyParty - nonNotifyParty - doesNotApply associatedFacilityId: type: string example: IC49BB5707-698B-4E51-B3C0-85FA763B94CC description: The unique ID of the facility agreement, if any, that the declaration is attached to associatedFacilitySectionID: type: string example: '1' description: The sectionID of the section of the facility agreement, if any, that the declaration is attached to section: $ref: '#/components/schemas/RWLineGuidanceSet/properties/sections/items' facilityID: type: string example: IC4E49E958-870A-41B3-B60B-B5AAC51F48A5 description: The unique ID of the facility agreement, if any, that the risk being endorsed is attached to one newPercentage: type: string example: '50' description: The new percentage value of the line if the MTPC is modifying a line RWSignedLineSet: type: object properties: _id: type: string example: ICD0645233-E126-4768-AB15-0A8828F5F08C::FO::TOMYUNDERWRITING::ALL::SILS description: The unique ID of this document _rev: example: 1-087952cf08f44dae740c1c001e2d5ab2 type: string description: The revision number of this document channels: type: array items: type: string example: akhil_ALL description: The team channel names of the users who can see the risk these signed lines relate to createdAt: type: string example: '2024-02-21 15:05:47' description: The creation time of this document in YYYY-MM-DD HH:MM:SS format contents: type: array items: $ref: '#/components/schemas/RWQuotedLine/properties/line/items' provenance: $ref: '#/components/schemas/ExtendedMRC/properties/provenance' type: type: string description: The JMRC type name for this document. Always RWSignedLineSet example: RWSignedLineSet updatedAt: type: string example: '2024-02-21 15:05:47' description: The date and time that this document was last updated in YYYY-MM-DD HH:MM:SS format isOffline: type: boolean example: true description: True if the stamp is associated with an offline (re)insurer parentDocID: type: string example: ICD0645233-E126-4768-AB15-0A8828F5F08C::FO::TOMYUNDERWRITING::ALL description: The unique ID of the related RWPlacing document required: - _id - _rev - channels - createdAt - line - parentDocID - provenance - type - updatedAt RWLineGuidanceSet: type: object properties: sections: type: array items: type: object properties: index: type: number example: 1 leadUnderwriterChannel: type: string example: offlineafricare_ALL description: The name of the leader's team channel multiSectionName: type: string description: The name of the section example: Hull multiSectionId: type: string description: The ID number of the section example: '1' leadUnderwriter: type: string example: OFFLINEAFRICANRE ALL description: The leader's company and team IDs leadUnderwriterFacility: type: string example: ICD77B5FD4-0790-42B9-BC53-65242FB96558 description: The unique ID of the leader's facility agreement contents: type: array items: type: object properties: conditionsEnabled: type: boolean example: true description: Whether there are any conditions on the guidance sectionIdentifiers: type: array items: type: string example: '1' description: The ID number of the section maxString: type: string example: '40' description: The maximum requested line percentage minString: type: string example: '30' description: The minimum requested line percentage suggestedStamps: $ref: '#/components/schemas/CorporateDetail/properties/stamps/items' role: description: Facility participation role type: string enum: - leader - agreementParty - notifyParty - nonNotifyParty - doesNotApply associatedFacilityId: type: string example: IC49BB5707-698B-4E51-B3C0-85FA763B94CC description: Unique ID of the facility agreement that the declaration is attached to. associatedFacilitySectionID: type: string example: '1' description: The sectionID of the section of the facility agreement, if any, that the declaration is attached to associatedPlacingID: type: string example: IC006DD9DA-A6EF-4320-BD23-C12D845282FF::FO description: The Unique ID of the Firm Order that this line guidance applies to _id: type: string description: The unique ID of this document example: IC006DD9DA-A6EF-4320-BD23-C12D845282FF::FO::CATANIA::ALL::LGUS _rev: type: string description: The revision number of this document example: 1-304aa44d6b3231c380ed83bbda5d8f08 channels: type: array items: type: string example: catania_ALL Provenance: $ref: '#/components/schemas/ExtendedMRC/properties/provenance' type: type: string description: The named JMRC type descriptor for this document example: RWLineGuidance securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT