Whitespace Data API

The Data API from Whitespace — 6 operation(s) for data.

Operations 8

GET /api/v22.04/data/{riskID} Gets all Defined Data for a Risk.
POST /api/v22.04/data/{riskID} Sets risk data through the Defined Data mechanism
GET /api/v22.04/data/{riskID}/tagset/{tagset} Gets all Defined Data for a Risk using an alternate tagset
POST /api/v22.04/data/{riskID}/verify Verifies the risk data to check that it is acceptable for the update POST
GET /api/v23.09/data/{riskID} Gets all tagged data for a risk using the default Whitespace Defined Data tagset.
POST /api/v23.09/data/{riskID} Sets tagged data in the risk through the Defined Data system.
GET /api/v23.09/data/{riskID}/tagset/{tagset} Gets all tagged data for a risk using an alternate set of data tags.
POST /api/v23.09/data/{riskID}/verify Verifies the data payload to check that it will be accepted by an update POST, and explains errors in detail.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/whitespace-london-data-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

whitespace-london-data-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 0.1.0
  title: Whitespace Platform Data API
  description: <div>Last update 29th May 2025</div> <p/> <div>Our intention is to cover the API calls most of use to those wanting  to integrate external systems to the Whitespace Platform. We will give  some descriptions about usage, but put full detail in standalone documents at  <a href='https://apidocs.whitespace.co.uk/'>https://apidocs.whitespace.co.uk/</a>. We intend to have the published endpoints and schemas documented to the  level that the code generated can be used safely and without modification to call our APIs safely.</div>  <p/> <div>Calls exclusive to brokers or underwriters have a comment of Broker Only and Underwriter Only respectively. All other calls work for both, but functionality might depend on the stage the risk is at, or other contextual factors.</div> <div>Where certain properties refer to RootID or similar, they are actually referring to the ID of the entire slip, encompassing all stages and instances of the contract. This is a unique 38-character reference starting with the letters IC. If they mention riskID or docID or placingID, these are refering to the ID of a specific document or contract instance within the slip. This is always the RootID of the base slip followed by a double colon, ::, and further characters.</div> <div> Once your Integration is ready to go live, the URL for production is <b>https://www.whitespaceplatform.com</b></div>
servers:
- description: Sandbox Environment
  url: https://sandbox.whitespace.co.uk/
- description: Tess Environment
  url: https://tess.whitespace.co.uk/
- description: Beta Environment
  url: https://beta.whitespace.co.uk/
- description: Staging Environment
  url: https://staging.whitespace.co.uk/
security:
- bearerAuth: []
tags:
- name: Data
paths:
  /api/v22.04/data/{riskID}:
    get:
      summary: Gets all Defined Data for a Risk.
      description: <div>This endpoint returns the Defined Data for a risk. NOTE that this is the old version, new integrators please use v23.09.</div>
      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
      responses:
        '200':
          description: the defined data document, containing metadata, multiSectionDefinition and definedData
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinedData'
              examples:
                Simple Case:
                  description: an example with a small number of obvious tags
                  value:
                    metadata:
                      documentRevision: 4-f33624e96b21035db9a370901c961e74
                      userID: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5
                      env: apitest
                      tagSet: Whitespace
                      version: '22.04'
                      fetchedAt: '2022-05-27 13:35:24'
                      documentID: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
                    multiSectionDefinition: []
                    definedData:
                    - value: B0999MT2705110219
                      tag: Broker_Reference
                      mrcHeading: UMR
                      originalHeading: UMR
                      name: DefinedData0
                      parentID: Page:C09BF702-7E21-4200-AA41-0EDADF934635
                      lineItemIndex: 1
                    - value: Acme Widgets Inc
                      tag: Insured_Name
                      mrcHeading: Insured
                      originalHeading: INSURED
                      name: DefinedData0
                      parentID: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF
                      lineItemIndex: 3
                    - value: 1 January 2022
                      tag: Inception_Date
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData3
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                    - value: 31 December 2022
                      tag: Expiry_Date
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData2
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                    - value: 00.01 am
                      tag: Expiry_Time
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData1
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                    - value: 00.01 am
                      tag: Inception_Time
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData1
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                    - value: Local Standard Time
                      tag: Time_Qualifier
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData0
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                    - originalHeading: PLACING DATA
                      mrcHeading: Information
                      tag: Instruction_Type
                      value: Insurance
                      controlled: true
                      parentID: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
                Sectioned Case:
                  description: an example with different periods for the Hull and Cargo sections
                  value:
                    metadata:
                      documentID: ICE46B12E0-1C2B-46A5-AFC5-60445CEE40B9
                      documentRevision: 8-cef176382e9f01c8007843b32d935876
                      env: apitest
                      version: '22.04'
                      fetchedAt: '2022-05-27 14:18:03'
                      userID: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5
                      tagSet: Whitespace
                    definedData:
                    - parentID: Page:C09BF702-7E21-4200-AA41-0EDADF934635
                      mrcHeading: UMR
                      tag: Broker_Reference
                      value: B0999MT2705111325
                      lineItemIndex: 1
                      name: DefinedData0
                      originalHeading: UMR
                    - parentID: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF
                      mrcHeading: Insured
                      tag: Insured_Name
                      value: Sectioned Widgets Inc
                      lineItemIndex: 3
                      originalHeading: INSURED
                      name: DefinedData0
                    - parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      sectionIDs:
                      - '1'
                      mrcHeading: Period
                      value: 1 January 2022
                      tag: Inception_Date
                      lineItemIndex: 5
                      originalHeading: PERIOD
                      name: DefinedData3
                    - parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      sectionIDs:
                      - '1'
                      mrcHeading: Period
                      tag: Expiry_Date
                      value: 31 December 2022
                      lineItemIndex: 5
                      originalHeading: PERIOD
                      name: DefinedData2
                    - parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      sectionIDs:
                      - '1'
                      mrcHeading: Period
                      value: 00.01 am
                      tag: Expiry_Time
                      lineItemIndex: 5
                      name: DefinedData1
                      originalHeading: PERIOD
                    - parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      sectionIDs:
                      - '1'
                      mrcHeading: Period
                      tag: Inception_Time
                      value: 00.01 am
                      lineItemIndex: 5
                      name: DefinedData1
                      originalHeading: PERIOD
                    - parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      sectionIDs:
                      - '1'
                      mrcHeading: Period
                      value: Local Standard Time
                      tag: Time_Qualifier
                      lineItemIndex: 5
                      originalHeading: PERIOD
                      name: DefinedData0
                    - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                      sectionIDs:
                      - '2'
                      mrcHeading: Period
                      tag: Inception_Date
                      value: 1 February 2022
                      lineItemIndex: 5
                      name: DefinedData4
                      originalHeading: PERIOD
                    - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                      sectionIDs:
                      - '2'
                      mrcHeading: Period
                      value: 28 February 2022
                      tag: Expiry_Date
                      lineItemIndex: 5
                      name: DefinedData5
                      originalHeading: PERIOD
                    - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                      sectionIDs:
                      - '2'
                      mrcHeading: Period
                      tag: Expiry_Time
                      value: 00.01 am
                      lineItemIndex: 5
                      name: DefinedData6
                      originalHeading: PERIOD
                    - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                      sectionIDs:
                      - '2'
                      mrcHeading: Period
                      value: 00.01 am
                      tag: Inception_Time
                      lineItemIndex: 5
                      name: DefinedData6
                      originalHeading: PERIOD
                    - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                      sectionIDs:
                      - '2'
                      mrcHeading: Period
                      value: Local Standard Time
                      tag: Time_Qualifier
                      lineItemIndex: 5
                      name: DefinedData7
                      originalHeading: PERIOD
                    - parentID: ICE46B12E0-1C2B-46A5-AFC5-60445CEE40B9
                      sectionIDs:
                      - '1'
                      mrcHeading: Information
                      controlled: true
                      value: B0999MT2705111325_01
                      tag: Broker_Contract_Section_Reference
                      originalHeading: PLACING DATA
                    - parentID: ICE46B12E0-1C2B-46A5-AFC5-60445CEE40B9
                      sectionIDs:
                      - '2'
                      mrcHeading: Information
                      controlled: true
                      tag: Broker_Contract_Section_Reference
                      value: B0999MT2705111325_02
                      originalHeading: PLACING DATA
                    - parentID: ICE46B12E0-1C2B-46A5-AFC5-60445CEE40B9
                      mrcHeading: Information
                      originalHeading: PLACING DATA
                      controlled: true
                      value: Insurance
                      tag: Insurance_Type
                    multiSectionDefinition:
                    - sectionName: Hull
                      sectionID: '1'
                    - sectionName: Cargo
                      sectionID: '2'
                Tabular Data:
                  description: an example with a table of insured addresses in the Interest heading
                  value:
                    multiSectionDefinition: []
                    metadata:
                      env: apitest
                      fetchedAt: '2022-05-27 14:41:19'
                      version: '22.04'
                      tagSet: Whitespace
                      documentID: IC10400763-38A3-4E60-8E53-BBB96F7B4B6E
                      documentRevision: 5-ce8a405a629a01249f5940ec5aa4526a
                      userID: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5
                    definedData:
                    - parentID: Page:C09BF702-7E21-4200-AA41-0EDADF934635
                      mrcHeading: UMR
                      originalHeading: UMR
                      tag: Broker_Reference
                      lineItemIndex: 1
                      name: DefinedData0
                      value: B0999MT2705111324
                    - parentID: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF
                      mrcHeading: Insured
                      originalHeading: INSURED
                      tag: Insured_Name
                      lineItemIndex: 3
                      name: DefinedData0
                      value: Tabular Widgets Inc
                    - parentID: Page:EB65EE6D-5AC2-4B7B-BD3D-0BB62E54930E
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Number_and_Street
                      lineItemIndex: 6
                      name: DefinedDataTable0:0
                      value: 1700 Main Street
                    - parentID: Page:FEB0900C-6C49-477A-B2C6-2FA7F57E966F
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Number_and_Street
                      lineItemIndex: 6
                      name: DefinedDataTable0:1
                      value: 1800 Second Avenue
                    - parentID: Page:EB65EE6D-5AC2-4B7B-BD3D-0BB62E54930E
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_City_Name
                      lineItemIndex: 6
                      name: DefinedDataTable0:2
                      value: Des Moines
                    - parentID: Page:FEB0900C-6C49-477A-B2C6-2FA7F57E966F
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_City_Name
                      lineItemIndex: 6
                      name: DefinedDataTable0:3
                      value: Omaha
                    - parentID: Page:EB65EE6D-5AC2-4B7B-BD3D-0BB62E54930E
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Country_Subentity
                      lineItemIndex: 6
                      name: DefinedDataTable0:4
                      value: Iowa
                    - parentID: Page:FEB0900C-6C49-477A-B2C6-2FA7F57E966F
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Country_Subentity
                      lineItemIndex: 6
                      name: DefinedDataTable0:5
                      value: Nebraska
                    - parentID: Page:EB65EE6D-5AC2-4B7B-BD3D-0BB62E54930E
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Postal_Code
                      lineItemIndex: 6
                      name: DefinedDataTable0:6
                      value: '50304'
                    - parentID: Page:FEB0900C-6C49-477A-B2C6-2FA7F57E966F
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Postal_Code
                      lineItemIndex: 6
                      name: DefinedDataTable0:7
                      value: '68022'
                    - parentID: Page:EB65EE6D-5AC2-4B7B-BD3D-0BB62E54930E
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Coverage_Limit_Amount
                      lineItemIndex: 6
                      name: DefinedDataTable0:8
                      value: USD 1,000,000
                    - parentID: Page:FEB0900C-6C49-477A-B2C6-2FA7F57E966F
                      mrcHeading: Interest
                      originalHeading: INTEREST
                      tag: Insured_Item_Coverage_Limit_Amount
                      lineItemIndex: 6
                      name: DefinedDataTable0:9
                      value: USD 800,000
                    - controlled: true
                      originalHeading: PLACING DATA
                      tag: Instruction_Type
                      mrcHeading: Information
                      value: Insurance
                      parentID: IC10400763-38A3-4E60-8E53-BBB96F7B4B6E
                Signed Lines Data:
                  description: an example with the written and signed lines data shown as 'controlled' values
                  value:
                    multiSectionDefinition: []
                    metadata:
                      userID: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5
                      fetchedAt: '2022-05-27 14:44:02'
                      documentRevision: 1-9040f0615d52afdcebbe7d46aedfb89d
                      version: '22.04'
                      documentID: ICF42A7472-3CFE-4722-A59C-678A60FACD53::SIGNED
                      tagSet: Whitespace
                      env: apitest
                    definedData:
                    - controlled: true
                      tag: Instruction_Type
                      parentID: ICF42A7472-3CFE-4722-A59C-678A60FACD53
                      mrcHeading: Information
                      originalHeading: PLACING DATA
                      value: Insurance
                    - controlled: true
                      tag: Insurer_Identification
                      mrcHeading: InsurersWrittenLine
                      value: '5679'
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
                    - controlled: true
                      tag: Insurer_Identification_Agency
                      mrcHeading: InsurersWrittenLine
                      value: Lloyd's Syndicate Number
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
                    - mrcHeading: InsurersWrittenLine
                      controlled: true
                      tag: Written_Line_Percentage
                      phType: Percentage
                      value: 100%
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
                    - mrcHeading: InsurersWrittenLine
                      tag: Written_Date_Time
                      controlled: true
                      value: '2022-05-27 01:10:13'
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
                    - mrcHeading: InsurersWrittenLine
                      tag: Signed_Line_Percentage
                      controlled: true
                      phType: Percentage
                      value: 100%
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
                    - mrcHeading: InsurersWrittenLine
                      tag: Insurer_Contract_Reference
                      controlled: true
                      value: TESTING05231
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2::0
                      sectionIDs: []
                    - mrcHeading: InsurersWrittenLine
                      controlled: true
                      tag: Insurer_Contract_Reference_Risk_Codes
                      value: '955'
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2::0
                      sectionIDs: []
                    - controlled: true
                      mrcHeading: InsurersWrittenLine
                      tag: Line_To_Stand_Indicator
                      value: Line To Stand
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
                    - controlled: true
                      tag: Year_Of_Account
                      mrcHeading: InsurersWrittenLine
                      value: '2022'
                      originalHeading: WRITTEN LINES
                      parentID: STB08B9750-CADF-4E86-B778-FECB7A6A4FA2
                      sectionIDs: []
    post:
      summary: Sets risk data through the Defined Data mechanism
      description: <div>The payload needs the metadata from a previous GET, a multiSectionDefinition array which can be empty, and a definedData array with the values to be updated.</div> <p>You can NOT have an empty string as a value for a tag, please use ??? as the placeholder instead.</p>
      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:
            examples:
              Single Value:
                description: Update just one tagged item
                value:
                  metadata:
                    documentRevision: 5-d5e0cc635b2d8ce4c07a7c9eda10baea
                    userID: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5
                    env: apitest
                    tagSet: Whitespace
                    version: '22.04'
                    fetchedAt: '2022-05-27 13:35:24'
                    documentID: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
                  multiSectionDefinition: []
                  definedData:
                  - value: Acme Widgets Incorporated
                    tag: Insured_Name
                    mrcHeading: Insured
                    originalHeading: INSURED
                    name: DefinedData0
                    parentID: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF
                    lineItemIndex: 3
              Sectioned Value:
                description: Update two items in one section
                value:
                  metadata:
                    documentRevision: 8-cef176382e9f01c8007843b32d935876
                  definedData:
                  - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                    sectionIDs:
                    - '2'
                    mrcHeading: Period
                    tag: Inception_Date
                    value: 1 March 2022
                    lineItemIndex: 5
                    name: DefinedData4
                    originalHeading: PERIOD
                  - parentID: Page:4C782AB9-72D4-413D-BB54-3CFAE0CAD679
                    sectionIDs:
                    - '2'
                    mrcHeading: Period
                    value: 31 March 2022
                    tag: Expiry_Date
                    lineItemIndex: 5
                    name: DefinedData5
                    originalHeading: PERIOD
                  multiSectionDefinition: []
              Using ACORD Tags:
                description: Update items using ACORD Tags
                value:
                  metadata:
                    documentRevision: 19-72f8cb0c5521b85e229be1d2c23bbc24
                  definedData:
                  - tag: ACORDGPM:InsuredAddressNumberAndStreet
                    originalHeading: 'INSURED ADDRESS:'
                    mrcHeading: PrincipalAddress
                    parentID: Page:6F87933A-9E25-4EB9-AFE1-16159B326411
                    name: DefinedData0
                    lineItemIndex: 4
                    value: 1404 First Avenue
                  - mrcHeading: PrincipalAddress
                    tag: ACORDGPM:InsuredAddressCityName
                    originalHeading: 'INSURED ADDRESS:'
                    parentID: Page:6F87933A-9E25-4EB9-AFE1-16159B326411
                    name: DefinedData1
                    lineItemIndex: 4
                    value: Des Moines
                  - mrcHeading: PrincipalAddress
                    tag: ACORDGPM:InsuredAddressCountrySubEntity
                    originalHeading: 'INSURED ADDRESS:'
                    parentID: Page:6F87933A-9E25-4EB9-AFE1-16159B326411
                    name: DefinedData2
                    lineItemIndex: 4
                    value: Omaha
                  - mrcHeading: PrincipalAddress
                    originalHeading: 'INSURED ADDRESS:'
                    tag: ACORDGPM:InsuredAddressZipOrPostCode
                    parentID: Page:6F87933A-9E25-4EB9-AFE1-16159B326411
                    name: DefinedData3
                    lineItemIndex: 4
                    value: '50304'
                  - mrcHeading: PrincipalAddress
                    originalHeading: 'INSURED ADDRESS:'
                    tag: ACORDGPM:InsuredAddressCountry
                    parentID: Page:6F87933A-9E25-4EB9-AFE1-16159B326411
                    name: DefinedData4
                    lineItemIndex: 4
                    value: United States
                  multiSectionDefinition: []
            schema:
              $ref: '#/components/schemas/DefinedData'
      responses:
        '200':
          description: A confirmation of the saved data
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: the document id of the updated risk
                    example: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
                  rev:
                    type: string
                    description: the revision of the risk
                    example: 6-50cb52029b9542862e014c296db45ae6
                  ok:
                    type: boolean
                    description: true if the data was saved
                    example: true
        '500':
          description: The data was not acceptable. We recommend calling the /api/v22.04/data/$RiskID/verify POST endpoint first which will report any errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    example: true
                  reason:
                    type: string
                    example: Something went wrong.
  /api/v22.04/data/{riskID}/tagset/{tagset}:
    get:
      summary: Gets all Defined Data for a Risk using an alternate tagset
      description: <div>This endpoint returns the Defined Data for a risk</div>
      parameters:
      - in: path
        name: riskID
        schema:
          type: string
        required: true
        description: The unique ID of the risk
        example: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
      - in: path
        name: tagset
        schema:
          type: string
        required: true
        description: An alternative tagset to the default. Currently supported ACORDGPM
        example: ACORDGPM
      tags:
      - Data
      responses:
        '200':
          description: the defined data document, containing metadata, multiSectionDefinition and definedData
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinedData'
              examples:
                ACORDGPM:
                  description: note that some of the tag values have a prefix of ACORDGPM and a suffix without underscores
                  value:
                    metadata:
                      documentRevision: 7-9e4693f54fa3c7181a3e60ed317c51cb
                      fetchedAt: '2022-05-27 15:16:35'
                      tagSet: ACORDGPM
                      version: '22.04'
                      env: apitest
                      userID: MUB6A6C9F9-61C1-49EA-8C44-28EEAB3226F5
                      documentID: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
                    multiSectionDefinition: []
                    definedData:
                    - parentID: Page:C09BF702-7E21-4200-AA41-0EDADF934635
                      value: B0999MT2705110219
                      lineItemIndex: 1
                      tag: ACORDGPM:BrokerContractReference
                      originalHeading: UMR
                      mrcHeading: UMR
                      name: DefinedData0
                    - parentID: Page:AB9B8D46-D6BC-442E-A01A-65E2F34096DF
                      value: Acme Widgets Incorporated
                      lineItemIndex: 3
                      originalHeading: INSURED
                      tag: ACORDGPM:InsuredName
                      mrcHeading: Insured
                      name: DefinedData0
                    - value: 1 January 2022
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                      originalHeading: PERIOD
                      mrcHeading: Period
                      tag: ACORDGPM:InceptionDate
                      name: DefinedData3
                    - value: 31 December 2022
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                      tag: ACORDGPM:ExpiryDate
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData2
                    - value: 00.01 am
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                      tag: ACORDGPM:ExpiryTime
                      mrcHeading: Period
                      originalHeading: PERIOD
                      name: DefinedData1
                    - parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      value: 00.01 am
                      lineItemIndex: 5
                      originalHeading: PERIOD
                      mrcHeading: Period
                      tag: ACORDGPM:InceptionTime
                      name: DefinedData1
                    - value: Local Standard Time
                      parentID: Page:D9056331-440A-4120-B8AF-37C7B9C91E72
                      lineItemIndex: 5
                      tag: ACORDGPM:TimeQualifier
                      originalHeading: PERIOD
                      mrcHeading: Period
                      name: DefinedData0
                    - parentID: IC442C1B93-DE19-4A52-A1D6-E3A4B47C4F6C
                      value: Insurance
                      tag: ACORDGPM:InstructionType
                      mrcHeading: Information
                      controlled: true
                      originalHeading: PLACING DATA
  /api/v22.04/data/{riskID}/verify:
    post:
      summary: Verifies the risk data to check that it is acceptable for the update POST
      description: <div>This endpoint describes any problems with the data that is intended to be sent to POST /api/v22.04/data/$RiskID.</div> <div>It just does a verify, it <b>does not</b> save any data.</div>
      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:
            schema:
              $ref: '#/components/schemas/DefinedData'
      responses:
        '200':
          description: An array of problems with the data. If an empty array, the data is acceptable
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties

# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/whitespace-london/refs/heads/main/openapi/whitespace-london-data-api-openapi.yml