Skip to main content
The FrankieOne API returns all errors in a standard format error object.

​
ErrorObject

The ErrorObject consists of the following attributes:
  • ErrorCode: One of the standard error codes (see below)
  • ErrorMsg: A human-readable message describing the error
  • HttpStatusCode: The HTTP result code
  • Issues: An array of additional error helpers, used to define where errors have occurred. Each element in the array consist of:
Issue: This is a description of the issue. IssueLocation: Identifies where in the payload or process the issue occurred.
Error Object
{
  "commit":"2af478ed"
  "errorCode":"CORE-5990"
  "errorMsg":"Everything went kaflooey. Stay clam."
  "httpStatusCode":501
  "issues":[
    {
    "issue":"Invalid format. Must be YYYY-MM-DD"
    "issueLocation":"dateOfBirth"
    }
  ]
  "requestId":"01BFJA617JMJXEW6G7TDDXNSHX"
}

​
Full List of Error Codes

The FrankieOne standard ErrorObject has a field called “ErrorCode” which is made up of a prefix and a 4 digit number. The prefix is the Issue Location and describes the system domain, layer, or service where the issue has occurred.
Note on Error Codes
The 4-digit number is the error code itself. These are shared across all domains.
The tables below will describe the issue locations and error codes. In a number of cases, it suggests you contact the developer support team for further assistance. If this is the case, see here: Contacting Developer Support In the API responses the error number will come combined with the issue code for example ENT-1065 or VAL-1010
Issue LocationDescription
CODEErrors detected in the code. Indicates something unexpected has occurred. Please contact support as per the details below.
AUTHAuthorization/security related errors.
SYSSystem level errors. Please contact support if you repeatedly get these errors.
APIErrors in your API message. Indicates an incorrectly constructed message.
VALAPI Data validation errors. See the issue details for more.
DOCErrors related directly to Document functions
ENTErrors related directly to Entity functions
CHECKErrors related to Check/Verify functions - Indicates potential issues with a check you’re trying to perform, rather than the results of a check per se.
ADMINAdmin API errors. Please contact developer support should you receive one of these errors
Returned by internal processes. Generally indicate a temporary issue, but please contact developer support if the issue persists.
Error NumberHTTP Error CodeDescription
0000500Unknown internal error. Contact developer support
0001500Internal error. Contact developer support.
0002401Not authorised to perform this function
0003500Internal error. Contact developer support.
0004500Internal error. Contact developer support.
0005500Internal error. Contact developer support.
0006500Internal error. Contact developer support.
0007503No service providers available/configured. Contact developer support
0008503No document scanning service available/configured. Contact developer support
0009503No document verification service available/configured. Contact developer support
0010503No comparison service available/configured. Contact developer support
0011503No industry service available/configured. Contact developer support
0012501Requested service (comparison) isn’t supported for your current configuration. Contact developer support.
0013501Requested service (scan) isn’t supported for your current configuration. Contact developer support.
0014501Requested service (document verify) isn’t supported for your current configuration. Contact developer support.
0015501Requested service (industry function) isn’t supported for your current configuration. Contact developer support.
0016501Requested service (entity verify) isn’t supported for your current configuration. Contact developer support.
0017501Requested service (specific entity check type) isn’t supported for your current configuration. Contact developer support.
0018503No entity verification service available/configured. Contact developer support
0019503Internal error. Contact developer support.
0020500Internal error. Contact developer support.
0021500Internal error. Contact developer support.
0022500Internal error. Contact developer support.
0023500Internal error. Contact developer support.
0024500Internal error. Contact developer support.
0025500Internal error. Contact developer support.
0026500Internal error. Contact developer support.
0027500Internal error. Contact developer support.
0028500Internal error. Contact developer support.
0029500Internal error. Contact developer support.
0030500Internal error. Contact developer support.
0031500Internal error. Contact developer support.
0032500Cache retrieve error. Contact developer support.
0033500Internal error. Contact developer support.
0034500Internal error. Contact developer support.
0035503Push to mobile service not available
Returned when no distinct error code is available (usually internal framework generated)
Error NumberHTTP Error CodeDescription
400400Generic 400 Error - See error message for details
401401Generic 401 Error - See error message for details
404404Generic 404 Error - See error message for details
405405Generic 405 Error - See error message for details
415415Generic 415 Error - See error message for details
422422Generic 422 Error - See error message for details
429429Generic 429 Error - See error message for details
500500Generic 500 Error - See error message for details
501501Generic 501 Error - See error message for details
503503Generic 503 Error - See error message for details
The API returns these errors when it receives unsupported or missing header data
Error NumberHTTP Error CodeDescription
801400Missing header: RequestID
802400Missing header: CheckID
901400Malformed header: RequestID
902400Malformed header: CheckID
The API returns these errors when it encounters issues with specific requests
Error NumberHTTP Error CodeDescription
1001400Blank value supplied when one needed
1002400Data supplied is incorrect/badly formatted.
1003405Can’t merge different documents or entities
1004400Can’t set document ID
1005400Data conversion issue
1006422Document supplied is unparsable
1007400Can’t set entity ID
1008400Entity supplied is unparsable
1009404Requested document isn’t found
1010404Requested entity isn’t found
1011422Not enough data supplied to perform requested check
1012500Can’t mark record as deleted
1013400Utility bill not supplied
1014400Document not a PDF when PDF expected
1015400Scan data not supplied when scan expected
1016501Error response returned from utility processor
1017202Verification results incomplete - expect a notification push
1018415Media type not supported
1019400End date before start date
1020400Bad page number
1021400Bad page count request
1022404Requested check ID not found
1023404Can’t retrieve original document
1024404Cache returned a nil result
1025400Geocode empty
1026400Multiple geocode results or inexact address match
1027400Bad geocode result - Address not found
1028400Invalid country or country code
1029401Attempt to access unauthorised data
1030400Entity state precludes requested flag setting
1031Reserved
1032Reserved
1033Reserved
1034Reserved
1035Reserved
1036Reserved
1037Reserved
1038Reserved
1039Reserved
1040Reserved
1041400Identity document required
1042400Incorrect ID type
1043400Missing mobile number
1044400Missing name
1045400Empty name
1046400Entity ineligible for service or in unsupported jurisdiction
1047400Push to Mobile service returned PTM service offline
1048404PTM service couldn’t find the token requested
1049404Internal error. Contact developer support.
1050503No business query service available at this time.
1051503Failed to schedule background job
1052500Business processor returned empty result set
1053400Supplied entity isn’t of a suitable type
1054400The requested operation amounted to no work
1055400A required prior result has expired
1056500The background operation couldn’t continue because required data was modified
1057500The background operation couldn’t continue because required data was missing
1058500No result was obtained in a reasonable time
1059500Inconsistent result from business processor
1060400Mismatch between ownership request and ABR response
1061400Can’t change status of check result
1062403Operation not permitted, entity is in inactive state
1063500Report service exists but failed to generate a report or we couldn’t save the result
1064400Document not owned by entity requested in document/verify function
1065400Named entity profile not configured
1066400Entity doesn’t have an assigned profile
1067400Entity profiles aren’t enabled for customer
1068400Missing application id or referrer when requesting an IDV token
1069400Invalid request to token service for a token
1070422Invalid request (unprocessable) to token service for a token
1071500Reserved
1072400Refresh token with mismatch applicant id
1073500The expected or default policy isn’t configured
1074500Attempt to toggle entity monitoring failed
1075422Importing past results failed
1076400Unknown business reportType
1077503No intl business service available
1078400No intl business search/profile criteria provided
1079400Intl business service rejected request
1080400No shared blocklist
1081400No shared blocklist reason
1082500Shared blocklist internal error
1083500Failed to get JWT signer or JWK key set
1084400Entity not in valid state for setting a manual state
1085404Requested entity isn’t retrievable at this time. NOTE: This is USUALLY transient, so wait 5 seconds and then retry
1086404Requested association doesn’t exist
1087400Requested association isn’t allowed
1088400Object not found from non-primary key search
1089500Internal error. Contact developer support.
1090400Device data supplied is either missing or incorrectly formatted
1091500Internal service error - please contact technical support
1092404Organisation can’t be found in the requested country’s registry
1093400The request contains an invalid parameter or argument
1094400Search criteria too broad and returned too many results. Please retry with narrower search criteria
1095400Incorrectly formatted organisation number
1096400The requested country registry is incorrect. Please ensure you have the right country registry code
1097503Unknown response from the registry
1098400No company registry for the requested country is available to query. This is often due to local regulations not making this data available
1099400Search by organisation_number not available for the jurisdiction
1100400This is reserved for future error handling
1101400This is reserved for future error handling
1102400This is reserved for future error handling
1103400This is reserved for future error handling
1104400This is reserved for future error handling
1105400This is reserved for future error handling