Error handling
The FrankieOne API uses a standardized error format to ensure that you can reliably handle issues that arise from bad requests, server problems, or invalid data. All non-2xx responses will return a consistent JSON error object. For a full list of error types and their meanings, see the API Error Codes documentation. This document replaces any specific error handling guides for individual products unless explicitly stated otherwise.Scenarios
The error response format is the same across all Transaction and Activity Monitoring API endpoints, including Evaluate an activity, Resolve alerts, and Classify activities. The examples below use the evaluate endpoint, but the response structure applies to all.Generic Bad request
HTTP Status Code : FrankieOne Error Code400 : VAL-0400
Bad request - Validation issues (Any business or process validation)
HTTP Status Code : FrankieOne Error Code400 : VAL-0400
Bad request - Schema issues
- Invalid limit or page parameter
beforeActivityAtis earlier thanafterActivityAt- Invalid sortField other than
activityAt afterActivityAtis in the future
400 : VAL-0400
Schema validation errors include the full OpenAPI path in the
issue field, which can be long. Parse issueLocation for the affected property.Bad request - Entity not found
HTTP Status Code : FrankieOne Error Code400 : VAL-0404
Duplicated transactions
HTTP Status Code : FrankieOne Error Code409 : VAL-0409
System errors
HTTP Status Code : FrankieOne Error Code500 : SYS-0500
More resources
- Implementation Overview — return to the full implementation map
- Evaluate an activity — check your request payload structure
- Key terms and definitions — reference for all TM terminology