InvestiFiPartner APIBeta
Prod Environment

Errors

Standard HTTP status codes and the validation error response shape.

Standard HTTP status codes.

StatusMeaning
404No matching resource exists within your FI. Returned by the detail endpoints.
422Validation error — malformed path or query parameters. The response body contains detail, an array of validation errors.
List, no matchesReturns 200 with an empty items array and total_records: 0, not a 404.

Validation error response body

export interface Response {
  detail?: ValidationError[]
}

export interface ValidationError {
  loc: (string | number)[]
  msg: string
  type: string
  input?: unknown
  ctx?: {}
}

Example 422 body

{
  "detail": [
    {
      "loc": ["query", "per_page"],
      "msg": "Input should be less than or equal to 100",
      "type": "less_than_equal",
      "input": "500",
      "ctx": {}
    }
  ]
}