Errors

The API uses standard HTTP response codes. If a request fails due to a validation error, the status code will be 400 and the API returns a JSON error object shaped like this:

{
  "error": "Validation failed for POST /v1/application",
  "path": "/v1/application",
  "detail": "Validation failed for POST /v1/application",
  "extra": [
    {
        "message": "Field required",
        "key": "application"
    },
    {
        "message": "Field required",
        "key": "company"
    }
  ]
}

Note: If an error occurs during application or document submission, the data was not received and must be corrected before resubmitting.

The above is an example of an application-create validation failure. Here's an example of a document-upload failure:

{
  "error": "Validation failed for POST /v1/document",
  "path": "/v1/document",
  "detail": "Validation failed for POST /v1/document",
  "extra": [
    {
      "message": "Object missing required field `type`",
      "key": "data",
      "source": "body"
    }
  ]
}

And finally, here's an example of a webhook create failure:

{
  "error": "Validation failed for POST /v1/webhooks",
  "path": "/v1/webhooks",
  "detail": "Validation failed for POST /v1/webhooks",
  "extra": [
    {
      "message": "Field required",
      "key": "webhook_url"
    }
  ]
}