Documentation Powered by Redocly

CaseYak Motor Vehicle Accident Case Value Prediction API (0.0.1)

Download OpenAPI specification:Download

CaseYak API Documentation

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: CASEYAK-API-KEY

inputs

Returns the inputs you can send CaseYak's API when requesting a case value prediction.

Authorizations:
ApiKeyAuth

    Responses

    Response samples

    Content type
    application/json
    {
    • "items": [
      ]
    }

    casevalue

    Returns a predicted case value based on the passed in inputs.

    Authorizations:
    ApiKeyAuth
      path Parameters
      state
      required
      string

      The state where the accident occured

      Request Body schema: application/json
      economic_damages
      required
      number

      The total economic damages of the injured party. REQUIRED

      county
      required
      string

      The county where the accident happened (eg Denver). REQUIRED

      plaintiff_sex
      string

      The sex of the plaintiff in the accident - use lowercase 'm' for male, 'f' for female, or 'undisclosed'. OPTIONAL

      Array of objects (inputs_present) unique [ items ]

      An array of inputs obtained from /mva/casevalue/inputs which you pass into the casevalue prediction API. OPTIONAL

      Responses

      Request samples

      Content type
      application/json
      {
      • "economic_damages": 0,
      • "county": "string",
      • "plaintiff_sex": "string",
      • "inputs": [
        ]
      }

      Response samples

      Content type
      application/json
      {
      • "casevalue": "string"
      }