Update Document and Run Utility Price Comparison.

v1.0.0

Using a previously uploaded but incomplete document, you can optionally supply updated details or simply request that the document be re-processed through the industry comparison service.

100's of datapoints are accurately extracted from the uploaded document. This data is then used to compare the bill against the whole market. A personalised comparison is returned that is a best fit for the customer's energy profile.

NOTE: It is expected that the type of document being uploaded will be a PDF and the idType is UTILITY_BILL. (These values will be set automatically if not supplied). You can optionally include the utility name (e.g. Origin Energy) in the idSubType if you wish.

Input

{
  "type": "object",
  "properties": {
    "X-Frankie-Background": {
      "type": "string"
    },
    "X-Frankie-CustomerChildID": {
      "type": "string"
    },
    "X-Frankie-CustomerID": {
      "type": "string"
    },
    "documentId": {
      "type": "string"
    },
    "planLimit": {
      "type": "string"
    }
  },
  "required": [
    "X-Frankie-CustomerID",
    "documentId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}