finov.ioDocumentationHome

Errors

API Documentation / API Conventions

API errors use application/problem+json and follow the Problem Details structure.

{
  "type": "https://api.finov.io/problems/validation-error",
  "title": "The request could not be validated",
  "status": 422,
  "detail": "One or more fields contain invalid values.",
  "request_id": "req_01J50Y7N6C4X8W2NV9P0Y6H3KQ",
  "errors": {
    "contact_id": [
      "The selected contact does not exist in this subsidiary."
    ],
    "date": [
      "The date must use YYYY-MM-DD."
    ]
  }
}

type, title, status, and request_id are always present. detail and errors are included when relevant. Clients may log request_id and provide it to Finovio support, but must not expose sensitive request data in their own logs.

Status codes

Status Meaning
400 Bad Request The request syntax, query parameters, or JSON could not be processed.
401 Unauthorized The access token is missing, expired, revoked, or invalid.
403 Forbidden The token is valid but lacks the required scope or does not grant the requested tenancy or subsidiary.
404 Not Found The resource does not exist within the granted context.
409 Conflict The request conflicts with current resource state or a uniqueness rule.
422 Unprocessable Content The JSON shape is valid but one or more field values fail validation.
423 Locked The subsidiary is write locked and the requested change is not permitted.
429 Too Many Requests The subsidiary grant's rate limit has been exceeded.
500 Internal Server Error Finovio encountered an unexpected error.
503 Service Unavailable The service is temporarily unavailable.

Authentication failures from OAuth endpoints use standard OAuth error values. Resource endpoint errors use the problem format above.

Information disclosure

Requests outside the token's granted context do not disclose resource details. Depending on the check being performed, Finovio returns 403 or 404 without confirming that another tenancy's resource exists.