openapi: 3.0.1 info: title: 'Data Capture: Quote and Risk Data (Sandbox)' description: "A sandbox version of the Data Capture API. This API provides a channel for partner systems to feed quote and risk data directly into Beazley's core Record of Risk systems. The current version of this API is V1.

\r\n\r\nPlease contact \r\nITArchitecture@Beazley.com if you have any questions about this API." version: '1.0' servers: - url: https://api.beazley.com/sandbox/riskcapture/v1 paths: /ping/: get: summary: GET Ping description: Validation call to confirm that you can connect to the API. operationId: 54c8996797fe1e0d805f714b responses: '200': description: '' '/risks/{id}': get: summary: GET Risk operationId: 54c8996797fe1e0d805f714c parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' put: summary: PUT risk description: Use the PUT method to update existing records. Note that the full risk object is required and any fields that are passed must have a value - blanks values will replace existing data with a empty string. operationId: 54c8996797fe1e0d805f714e parameters: - name: id in: path description: '' required: true schema: type: string requestBody: description: "

Model

\n
\nRisk \n{\n     SourceSystem (string, required): The name of the system from which the data has been extracted,\n     RiskUniqueID (string, required): An internal unique non-changing code to uniquely identify each risk,\n     RiskReference (string, required): An external facing reference code used to uniquely identify each risk,\n     BzyRiskReference (string, optional): Beazley re-keyed reference from our internal record of risk system,\n     Underwriter (string, required): The name of the Beazley underwriter linked to the risk,\n     PlacingBrokerID (string, optional): Beazley unique non-changing code to uniquely identify the broker,\n     PlacingBrokerGroup (string, required): The name of the primary broking firm that is placing the risk,\n     PlacingBrokerContact (string, optional): The contact name within the placing broker's organisation,\n     PlacingBrokerStateProvince (string, optional): Placing broker’s state or provide,\n     PlacingBrokerCountry (string, optional): Placing broker’s country 3 digit ISO 3166 code,\n     PlacingBrokerBranchName (string, optional): Distinct name for the placing broker’s office,\n     ProducingBrokerID (string, optional): Beazley unique non-changing code to uniquely identify the broker,\n     ProducingBrokerGroup (string, optional): The name of the producing broking firm that is placing the risk,\n     ProducingBrokerContact (string, optional): The contact name within the producing broker's organisation,\n     ProducingBrokerStateProvince (string, optional): Producing broker’s state or provide,\n     ProducingBrokerCountry (string, optional): Producing broker’s country 3 digit ISO 3166 code,\n     ProducingBrokerBranchName (string, optional): Distinct name for the producing broker’s office,\n     InsuredID (string, optional): Beazley unique non-changing code to uniquely identify the insured,\n     InsuredName (string, required): The name of the organisation or individual linked to the risk,\n     InsuredContact (string, optional): The primary contact name for the insured,\n     InsuredContactEmail (string, optional): The email address for the primary contact,\n     InsuredCity (string, optional): Insured’s city,\n     InsuredStateProvince (string, optional): Insured’s state or provide,\n     InsuredCountry (string, optional): Insured’s country 3 digit ISO 3166 code,\n     Sections (array[Section], required)\n}\nSection \n{\n     SectionUniqueID (string, optional): An internal unique non-changing code to uniquely identify each section,\n     SectionReference (string, required): An external facing reference code used to uniquely identify each section,\n     SectionSequenceID (integer, required): An incrementing integer beginning with 1 used to sequence sections within a risk,\n     CoverageName (string, required): Unique coverage name or description,\n     ClassOfBusinessCode (string, optional): Beazley categorisation code. Not the same as Lloyds' class of business code,\n     CreationDate (string, required): Creation date (ISO 8601),\n     InceptionDate (string, required): Inception date (ISO 8601),\n     ExpiryDate (string, optional): Expiration date (ISO 8601),\n     SectionStatus (string, required): Current status of the section\n}\n
" content: application/json: example: SourceSystem: myBeazley RiskUniqueID: 606ab36d-292a-4ebd-9357-f6ec598c240c RiskReference: ABC1234 BzyRiskReference: BZY65479321 Underwriter: Tom Jones PlacingBrokerID: ff0513fe-c363-4d8d-903a-36e936ac50d9 PlacingBrokerGroup: Joseph & Joseph PlacingBrokerContact: Sam Spade PlacingBrokerStateProvince: London PlacingBrokerCountry: GBR PlacingBrokerBranchName: 'Joseph & Joseph, London UK' ProducingBrokerID: df5da783-33bc-4e42-a25a-1879abc5c51a ProducingBrokerGroup: Sunway Brokerage ProducingBrokerContact: Thomas Callaway ProducingBrokerStateProvince: CA ProducingBrokerCountry: USA ProducingBrokerBranchName: 'Sunway, San Francisco - CA' InsuredID: 7ce92886-b75f-4db6-996c-c5ec8ce4e1a7 InsuredName: Rook Industries InsuredContact: Sebastian Rooks InsuredContactEmail: sebastian@rook.com InsuredCity: San Francisco InsuredStateProvince: CA InsuredCountry: USA Sections: - SectionUniqueID: 34c1dae2-e255-4ff1-b41a-0d8834b5474b SectionReference: '001' SectionSequenceID: '1' CoverageName: Breach ClassOfBusinessCode: WX CreationDate: '2014-10-20' InceptionDate: '2014-11-25' ExpiryDate: '2015-11-24' SectionStatus: Bound responses: '200': description: '' '400': description: '' /risks/: post: summary: POST Risk description: Use the POST method to create a new record. Please note that all required fields must include a non-blank value. operationId: 54c8996797fe1e0d805f714d requestBody: description: "

Model

\n
\nRisk \n{\n     SourceSystem (string, required): The name of the system from which the data has been extracted,\n     RiskUniqueID (string, required): An internal unique non-changing code to uniquely identify each risk,\n     RiskReference (string, required): An external facing reference code used to uniquely identify each risk,\n     BzyRiskReference (string, optional): Beazley re-keyed reference from our internal record of risk system,\n     Underwriter (string, required): The name of the Beazley underwriter linked to the risk,\n     PlacingBrokerID (string, optional): Beazley unique non-changing code to uniquely identify the broker,\n     PlacingBrokerGroup (string, required): The name of the primary broking firm that is placing the risk,\n     PlacingBrokerContact (string, optional): The contact name within the placing broker's organisation,\n     PlacingBrokerStateProvince (string, optional): Placing broker’s state or provide,\n     PlacingBrokerCountry (string, optional): Placing broker’s country 3 digit ISO 3166 code,\n     PlacingBrokerBranchName (string, optional): Distinct name for the placing broker’s office,\n     ProducingBrokerID (string, optional): Beazley unique non-changing code to uniquely identify the broker,\n     ProducingBrokerGroup (string, optional): The name of the producing broking firm that is placing the risk,\n     ProducingBrokerContact (string, optional): The contact name within the producing broker's organisation,\n     ProducingBrokerStateProvince (string, optional): Producing broker’s state or provide,\n     ProducingBrokerCountry (string, optional): Producing broker’s country 3 digit ISO 3166 code,\n     ProducingBrokerBranchName (string, optional): Distinct name for the producing broker’s office,\n     InsuredID (string, optional): Beazley unique non-changing code to uniquely identify the insured,\n     InsuredName (string, required): The name of the organisation or individual linked to the risk,\n     InsuredContact (string, optional): The primary contact name for the insured,\n     InsuredContactEmail (string, optional): The email address for the primary contact,\n     InsuredCity (string, optional): Insured’s city,\n     InsuredStateProvince (string, optional): Insured’s state or provide,\n     InsuredCountry (string, optional): Insured’s country 3 digit ISO 3166 code,\n     Sections (array[Section], required)\n}\nSection \n{\n     SectionUniqueID (string, optional): An internal unique non-changing code to uniquely identify each section,\n     SectionReference (string, required): An external facing reference code used to uniquely identify each section,\n     SectionSequenceID (integer, required): An incrementing integer beginning with 1 used to sequence sections within a risk,\n     CoverageName (string, required): Unique coverage name or description,\n     ClassOfBusinessCode (string, optional): Beazley categorisation code. Not the same as Lloyds' class of business code,\n     CreationDate (string, required): Creation date (ISO 8601),\n     InceptionDate (string, required): Inception date (ISO 8601),\n     ExpiryDate (string, optional): Expiration date (ISO 8601),\n     SectionStatus (string, required): Current status of the section\n}\n
" content: application/json: example: SourceSystem: myBeazley RiskUniqueID: 606ab36d-292a-4ebd-9357-f6ec598c240c RiskReference: ABC1234 BzyRiskReference: BZY65479321 Underwriter: Tom Jones PlacingBrokerID: ff0513fe-c363-4d8d-903a-36e936ac50d9 PlacingBrokerGroup: Joseph & Joseph PlacingBrokerContact: Sam Spade PlacingBrokerStateProvince: London PlacingBrokerCountry: GBR PlacingBrokerBranchName: 'Joseph & Joseph, London UK' ProducingBrokerID: df5da783-33bc-4e42-a25a-1879abc5c51a ProducingBrokerGroup: Sunway Brokerage ProducingBrokerContact: Thomas Callaway ProducingBrokerStateProvince: CA ProducingBrokerCountry: USA ProducingBrokerBranchName: 'Sunway, San Francisco - CA' InsuredID: 7ce92886-b75f-4db6-996c-c5ec8ce4e1a7 InsuredName: Rook Industries InsuredContact: Sebastian Rooks InsuredContactEmail: sebastian@rook.com InsuredCity: San Francisco InsuredStateProvince: CA InsuredCountry: USA Sections: - SectionUniqueID: 34c1dae2-e255-4ff1-b41a-0d8834b5474b SectionReference: '001' SectionSequenceID: '1' CoverageName: Breach ClassOfBusinessCode: WX CreationDate: '2014-10-20' InceptionDate: '2014-11-25' ExpiryDate: '2015-11-24' SectionStatus: Quoted responses: '400': description: '' '201': description: New risk entry created successfully. Responds with resource ID which must be recorded for all future PUTs. content: application/json: example: id: d7922e56-b527-4c01-a2a5-79ccc0dc7340 components: securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]