You can NOT have an empty string as a value for a tag, please use ??? as the placeholder instead.

This data now includes several items of implicit information retrieved and tagged by the endpoint itself, including these new Controlled tags -- Agreement_Party_Role, Participation_Basis, Premium_Discount_Indicator, Subjectivity_Indicator, Subjectivity_Due_Date, Subjectivity_Condition, Subjectivity_Terms, Section_Reference, Insurer_Identification_Pseudonym, Reinsurer_Identification_Pseudonym, Insurer_Identification_Split_Percentage, Reinsurer_Identification_Split_Percentage, Placing_Broker_Unique_Identifier, Placing_Broker_Unique_Identifier_Agency, Premium_Split_Type, Deductible_Or_Excess_Indicator, Other_Intermediary_Unique_Identifier_Type.

These implicit data tags are labelled with the term Controlled to clearly identify them.

For consistency''s sake please use the same version of the different Data API calls when working with the same information -- i.e., use 23.09 POST calls if you used 23.09 calls to GET the data.

You can NOT have an empty string as a value for a tag, please use ??? as the placeholder instead.

Unlike an update POST operation, it provides verbose error descriptions rather than a simple failure notification.

Please note that this call is solely for verification, it does not save any data.

parameters: - in: path name: riskID schema: type: string required: true description: The unique ID of the risk example: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C tags: - Data requestBody: content: application/json: example: metadata: tagSet: Whitespace documentRevision: 2-f19731b1229504652807f093a8179dbf env: apitest fetchedAt: '2023-11-27 10:51:29' documentID: ICA18B8998-6A42-45EF-BD9F-F8F58B182B99::DR2 version: '23.09' userID: MU9FCFC64E-7694-420A-BE61-2ABEDB3E8F52 definedData: - originalHeading: PERIOD value: 41 August 2022 phType: Date mrcHeading: Period name: DefinedData1 tag: Expiry_Date parentID: Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 lineItemIndex: 4 section: RiskDetails multiSectionDefinition: [] schema: $ref: '#/components/schemas/DefinedData' responses: '200': description: An array of all problems encountered when attempting to process the data. If this array is empty, the data will be accepted correctly if sent to a POST update. content: application/json: schema: type: array items: type: object properties: error: type: string description: Problems encountered while processing the data example: Tags do not match input. datapoints: type: array items: type: object description: The data point, containing a flat representation of each data value properties: value: type: string description: The value to be tagged as data example: Acme Widgets Inc tag: type: string description: The defined data tag that identifies the purpose of the value example: Insured_Name mrcHeading: type: string description: The standard Lloyd's MRC name for the contract heading that the data item falls under example: Insured originalHeading: type: string description: The contract heading that the data item falls under as displayed in the contract example: INSURED name: type: string description: The name of the placeholder used to locate the precise position of the data item in the contract text example: DefinedData0 parentID: type: string description: The reference identifying the page (or group) of data tags under a contract heading that the data item is part of example: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF sectionIDs: type: array items: type: string description: The section ID which links to the items in the multiSectionDefinition array example: '2' lineItemIndex: type: number description: The numerical index specifying the position in the document of the contract heading containing the data item example: 3 controlled: type: boolean description: When true, this flag indicates that the data item was created through a controlled process, for example Written Line or Signed Line percentages example: true example: - error: The tag Expiry_Date did not pass validation. datapoints: - tag: Expiry_Date lineItemIndex: 4 value: 41 August 2022 originalHeading: PERIOD name: DefinedData1 phType: Date mrcHeading: Period parentID: Page:17D6A8C3-4C32-4E5D-AD1D-0A7321C66535 section: RiskDetails components: schemas: DefinedData: type: object properties: metadata: type: object description: metadata for the risk from which the defined data is taken properties: documentRevision: type: string example: 5-d5e0cc635b2d8ce4c07a7c9eda10baea description: this must be sent to the update POST endpoint userID: type: string example: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5 description: the user who requested the data env: type: string example: apitest description: the environment from which the data came, to avoid confusion of sandbox versus production tagSet: type: string example: Whitespace description: by default Whitespace, but for instance ACORDCDR if called with the tagset option version: type: string example: '22.04' description: currently 22.04, to allow for a future new format fetchedAt: type: string example: '2022-05-27T13:35:24.000Z' description: date and time the data was fetched documentID: type: string example: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C description: the risk ID multiSectionDefinition: type: array items: type: object properties: sectionName: type: string description: the name of the section example: Hull sectionID: type: string description: the number of the section starting from 1 example: '2' contractHeadigs: type: array items: type: object properties: lineItemIndex: type: number description: the numerical index of the JMRC line item example: 3 mrcHeading: type: string description: the name of the heading example: contractType originalHeading: type: string description: the name of the heading as it will appear on the frontend example: 'TYPE:' section: type: string example: RiskDetails descritpion: the section the heading is in definedData: type: array items: type: object description:

The Data Point, containing a flat representation of each data value

The version described is for the v22.04 release of Defined Data, accessed as /api/v22.04/data/$RiskID. It is a flat structure which repeats mrcHeading, originalHeading and lineItemIndex when the data is in the same line item of the risk. Within that, parentID is used to group related data values, to cover sectioned data or the rows of a table.

We have versioned this as v22.04 to preserve it should a later format be required by our customers. Later versions will have vYY.MM instead.

properties: value: type: string description: the defined data value example: Acme Widgets Inc tag: type: string description: the tag that identifies the use of the data item example: Bad_Tag_Value mrcHeading: type: string description: the heading (from a fixed list) within the JMRC where the data item was located example: Insured originalHeading: type: string description: the heading visible to the user within the JMRC where the data item was located example: INSURED name: type: string description: the name of the defined data item's placeholder within the JMRC data example: DefinedData0 parentID: type: string description: a code that links set of data tags within a heading example: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF sectionIDs: type: array items: type: string description: section ID which links to the items in the multiSectionDefinition array example: '2' vertical: type: object description: Info on any vertical if the tag is part of verticalised heading properties: assignedCarrierPrefixes: type: array description: the channel prefixes of any carriers assigned to this vertical term items: type: string example: whitesails id: type: string example: V5A67D1D7-918D-4FEF-8B32-AF85A1B7F5A0_2 description: id of the vertical term lineItemIndex: type: number description: the numerical index of the JMRC line item where the data item was located example: 3 controlled: type: boolean description: if included as true, indicates an item created through a controlled process as opposed to a broker manually tagging, such as Written or Signed Line values example: true securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT