Recover API Errors
Error HTTP Status Codes#
Note that all non-error HTTP responses have a status 200 OK.
| Code | Status | Additional Info |
|---|---|---|
| 400 | Bad Request | |
| 404 | Not Found | |
| 409 | Conflict | |
| 415 | Unsupported Media Type | Used when the request has the wrong content type. For example, if the request body should be JSON (which all requests should be), but the actual body contains text. |
| 422 | Unprocessable Entity | |
| 500 | Internal Server Error |
Error Object#
When the Recover API encounters an error in the request or its internal processes, it returns a status 4XX HTTP response with an error object.
Error Schema#
| Key | Type | Required | Additional Info |
|---|---|---|---|
| status | Integer | TrueAccord API error code. See below Error Codes section for more information on these. | |
| msg | String | Message explaining the reason for the error. Generalized per endpoint. | |
| errorInfo | JSON | Additional JSON (usually String or Object) with further information about why the error occurred. Specific for the request. If there is no data for the errorInfo, the field contains the value null. |
Error Example:
Error Codes#
| Code | Type | Message | Additional Info |
|---|---|---|---|
| 102 | INVALID_REQUEST | Message varies. | Error message contains information about why the request was invalid. |
| 104 | INPUT_ERROR | Message varies. | General error used when there was an error with the input data. The error message contains more information. |
| 108 | PERSON_DOES _NOT_EXIST | "Person does not exist." | |
| 109 | CREDITOR_CUSTOMER _DOES_NOT_EXIST | "CreditorCustomer does not exist." | |
| 112 | CREDITOR_DOES _NOT_EXIST | "Creditor does not exist." | |
| 114 | OBJECT_ALREADY _EXISTS | "Object already exists." | Used in cases where the server enforces unique entities. |
| 115 | OBJECT_EXPIRED | "Object expired." | |
| 118 | EMAIL_ADDRESS _DOES_NOT_EXIST | "Email address does not exist" | |
| 119 | PAYMENT_PLAN _DOES_NOT_EXIST | "Payment Plan does not exist" | |
| 121 | DEBT_LOG_ENTRY _DOES_NOT_EXIST | "Debt Log Entry does not exist." | |
| 122 | DEBTS _DO_NOT_EXIST | "The following Debts do not exist." | Used when debts in the request do not exist in the system, although they should. Also returns a list of the debts that do not exist within the system |
| 124 | POSTAL_ADDRESS _DOES_NOT_EXIST | "Postal address does not exist" | |
| 202 | IN_PROGRESS | "Request is being processed." | |
| 204 | NO_CONTENT | ||
| 304 | NOT_MODIFIED | "Resource has not been modified" | |
| 403 | FORBIDDEN | "Insufficient privileges" | Error returned when the user tries to access a resource that they don't have access to. A common reason for this error is if the user fails to include the X-TA-CREDITOR header. |
| 404 | OBJECT_DOES _NOT_EXIST | "Object does not exist." | |
| 408 | TIMEOUT | "Request timed out." | |
| 409 | CONFLICT | Conflict. | |
| 422 | UNPROCESSABLE _ENTITY | Message varies. | Used when the request doesn't satisfy server requirements. See message for details. |
| 451 | COMPLIANCE_ERROR | Message varies. | Used when backend compliance checker system deems an action to be in violation of legal/compliance obligations. |
| 500 | INTERNAL_ERROR | "Internal error occurred" | Unspecified error occurred with the TrueAccord backend. |
| 501 | NOT_IMPLEMENTED | "Not implemented." |