Customer Identity API Errors
JSON error responses from the Customer Identity API include information in the body of the response similar to the following:
{
"error":{
"code":"5023",
"message":"You submitted a request that is not parseable.",
"details":[
"Unrecognized token 'fale': was expecting 'null', 'true', 'false' or NaN at [line: 4, column: 26]"
],
"fieldErrors": [{
"field": "email",
"error": "john@hi@you.c.c.c.c is not a valid e-mail address."
}, {
"field": "profile.firstName",
"error": "profile firstName is required."
}]
}
}
The error object consists of the following elements:
| Element | Type | Description | |
|---|---|---|---|
| code | string | The error code. Also shown in the X-Application-Status-Code response header. | |
| message | string | The error message describing the error. | |
| details | string array | Details of any parameter value errors in the body of the request. | |
| fieldErrors | field array | If applicable, this is a list of fields that contain errors. | |
To save you having to parse the response body to find the error information, you can retrieve the error code from the X-Application-Status-Code response header.
This is a summary of all errors that could be returned when using the Customer Identity API, including HTTP Status Codes.
HTTP Status Code Summary
| Code Range | Description |
|---|---|
| 1xx: Informational | Communicates transfer protocol–level information. |
| 2xx: Success | Indicates that the client’s request was accepted. |
| 3xx: Redirection | Indicates that the client must take some additional action in order to complete the request. |
| 4xx: Client Error | Indicates that the client has made an error with the request. |
| 5xx: Server Error | Indicates that an error occurred on the server side. |
Common HTTP Response Status Codes
| Code | Description |
|---|---|
| 200 OK | Everything worked as expected. |
| 201 Created | The request was successful. Paysafe created a new resource and the response body contains the representation. |
| 202 Accepted | This indicates that the client’s request will be handled asynchronously. It tells the client that the request appears valid, but it still may have problems once it is processed. |
| 204 No Content | This is usually returned in response to a PUT, POST, or DELETE request when the REST API declines to send back any status message or representation in the body of the response message. |
| 304 Not Modified | The client's cached version of the representation is still up to date. |
| 400 Bad Request | This often indicates that a required parameter is missing or that a parameter is invalid. This is a generic client-side error status, used when no other 4xx error code is appropriate. |
| 401 Unauthorized | This indicates that the client tried to operate on a protected resource without providing the proper authorization. They may have provided the wrong credentials or none at all. |
| 402 Payment Required | The parameters were valid but the request failed. |
| 404 Not Found | The requested resource does not exist. |
| 405 Method Not Allowed | The client tried to POST or PUT to a resource that would not accept it. |
| 415 Unsupported Media Type | The request is in a format not supported by the requested resource for the requested method. |
| 429 Too Many Requests | The application is sending too many simultaneous requests. |
| 500 Internal Server Error | An error occurred with an internal server. |
| 502 External Server Error | We received an invalid response from the upstream gateway in attempting to fulfill the request. |
Customer Identity Errors
| HTTP Status Code | Error Code | Description |
|---|---|---|
| 402 | CUSTOMER-IDENTITY-1 | One or more external services are down. Please rerun a Customer Identity Check request. |
| 400 | CUSTOMER-IDENTITY-2 | Your merchant account is not configured to process the payment type and currency combination you provided. |
| 409 | CUSTOMER-IDENTITY-3 | The request you have submitted has already been processed. |
| 200 | CUSTOMER-IDENTITY-4 | The address provided is a prison or detention facility. |
| 200 | CUSTOMER-IDENTITY-5 | The person is reported to be deceased. |
| 200 | CUSTOMER-IDENTITY-6 | The person is reported to be on a PEP (politically exposed person) list or a sanctions watchlist. |
| 200 | CUSTOMER-IDENTITY-7 | The request was rejected. |
| 200 | CUSTOMER-IDENTITY-8 | There has been a high number of validation attempts for the same person or address. |
| 200 | CUSTOMER-IDENTITY-9 | An identity theft alert has been raised. |
| 200 | CUSTOMER-IDENTITY-10 | The request includes invalid input for fields. Verify the parameters and retry the request. |
| 200 | CUSTOMER-IDENTITY-11 | The minimum age validation failed. |
| 200 | CUSTOMER-IDENTITY-12 | The address provided is invalid. Verify the parameters and retry the request. |
| 200 | CUSTOMER-IDENTITY-13 | The provider identity validation failed. |
Common Errors
| HTTP Status Code | Error Code | Description |
|---|---|---|
| 500 | 1000 | An internal error occurred. |
| 502 | 1001 | An error occurred with the external processing gateway. |
| 400 | 5005 | You submitted an invalid operation type with your request. |
| 400 | 5023 | The request is not parsable. |
| 400 | 5068 | Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected. |
| 406 | 5271 | You requested a response in the 'Accept' header that is in an unsupported format. |
| 406 | 5272 | The 'Content-Type' you specified in request header was submitted in an unsupported format. |
| 405 | 5281 | The request uses an action (e.g., GET, POST, or PUT) that is not supported by the resource. |
| 400 | 5502 | Either the payment token is invalid or the corresponding profile or bank account is not active. |