Claim Done

Every document Claim Done drafts, with its live flat price in AUD, what the person receives and how it is delivered.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Optional word to filter by, e.g. \"tenant\", \"invoice\", \"tribunal\"."
    }
  },
  "additionalProperties": false
}

Takes a plain-English description of the person's problem (who, what happened, what they want) and returns the Claim Done document that fits, its price in AUD, and what it does.

{
  "type": "object",
  "properties": {
    "problem": {
      "type": "string",
      "description": "The situation in the person's own words, 10 to 500 characters."
    }
  },
  "required": [
    "problem"
  ],
  "additionalProperties": false
}

Creates a Claim Done case for a document and returns the questions the person needs to answer, with a case_id and access_token for the later steps. Nothing is charged at this step.

{
  "type": "object",
  "properties": {
    "service": {
      "type": "string",
      "description": "Service slug from list_services or match_problem, e.g. \"letter-of-demand\"."
    },
    "state": {
      "type": "string",
      "enum": [
        "NSW",
        "VIC",
        "QLD",
        "WA",
        "SA",
        "TAS",
        "ACT",
        "NT"
      ],
      "description": "The person's Australian state or territory."
    },
    "what_happened": {
      "type": "string",
      "description": "What happened, in the person's words (2 to 6 sentences)."
    },
    "your_name": {
      "type": "string",
      "description": "The person's full name or business name, as it should appear on the document."
    },
    "your_email": {
      "type": "string",
      "description": "The person's email address: the draft, the receipt and the dashboard link go there."
    }
  },
  "required": [
    "service",
    "state",
    "what_happened",
    "your_name",
    "your_email"
  ],
  "additionalProperties": false
}

Saves the person's answers (question key => answer) for a case. Returns any questions still open, any follow-up questions the drafting needs, and ready_to_pay when the document can be drafted.

{
  "type": "object",
  "properties": {
    "case_id": {
      "type": "integer",
      "description": "The case id returned by start_document."
    },
    "access_token": {
      "type": "string",
      "description": "The access_token returned by start_document."
    },
    "answers": {
      "type": "object",
      "description": "Question key => the person's answer. For a question with choices, pass one choice exactly.",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "case_id",
    "access_token",
    "answers"
  ],
  "additionalProperties": false
}

Returns a hosted Stripe Checkout URL for the case at the live flat price, for the person to pay. The document is drafted automatically once payment goes through, usually within about 5 minutes. If the case carries an eligibility notice, the notice is returned and acknowledge_notice must be true before a link is issued.

{
  "type": "object",
  "properties": {
    "case_id": {
      "type": "integer",
      "description": "The case id returned by start_document."
    },
    "access_token": {
      "type": "string",
      "description": "The access_token returned by start_document."
    },
    "acknowledge_notice": {
      "type": "boolean",
      "description": "Set true after the person has heard the eligibility notice returned by answer_questions or a previous call."
    },
    "registered_post": {
      "type": "boolean",
      "description": "Add registered post delivery of a letter (extra fee, shown in list_services)."
    }
  },
  "required": [
    "case_id",
    "access_token"
  ],
  "additionalProperties": false
}

Whether the case is paid, whether the draft is ready, and the dashboard link where the person reads, edits and approves it.

{
  "type": "object",
  "properties": {
    "case_id": {
      "type": "integer",
      "description": "The case id returned by start_document."
    },
    "access_token": {
      "type": "string",
      "description": "The access_token returned by start_document."
    }
  },
  "required": [
    "case_id",
    "access_token"
  ],
  "additionalProperties": false
}

After payment: the full text of each drafted document, plus the dashboard link where the person reads, edits and approves it (and, for letters, has it sent). Documents are never sent without the person's approval on the dashboard.

{
  "type": "object",
  "properties": {
    "case_id": {
      "type": "integer",
      "description": "The case id returned by start_document."
    },
    "access_token": {
      "type": "string",
      "description": "The access_token returned by start_document."
    }
  },
  "required": [
    "case_id",
    "access_token"
  ],
  "additionalProperties": false
}