Status codes and messages
The following table lists the most common details and codes that are returned by the VIP REST APIs.
For Credential Management API error codes and messages, see Troubleshooting the Credential Management APIs.
HTTP Code | Error | Details | Cause/Solution |
|---|---|---|---|
201 | OK | Various. For example, Account <accountID> created successfully. | The operation requested in the API call completed successfully. |
400 | BAD_REQUEST | Invalid status. | The account status that was provided in the request is not valid. Enter a valid account status and try again. |
400 | BAD_REQUEST | [Field name] is mandatory. | A mandatory attribute was not provided in the request (for example, the account name or the organizational unit). Add the attribute and try again. |
400 | BAD_REQUEST | Account category must be either Enterprise, Consumer, or Corporate. | The request has attempted to set a member type that is not available. Retry with an available member type. |
400 | BAD_REQUEST | Invalid account status. | The request has attempted to update to a status that is not available for the account (for example, from ACTIVE to PENDING ). |
400 | BAD_REQUEST | Account category must be either Test, Production or Partner. | The request has attempted to set an account type that is not available. Retry with an available account type. |
400 | BAD_REQUEST | Not allowed to update serviceStartDate to earlier than current date. | The request has attempted to set a serviceStartDate that is in the past. Use a current date or a future date. |
400 | BAD_REQUEST | Unit Type must be USERS, CREDENTIALS or TRANSACTIONS. | The request has attempted to set a unit type that is not available. Retry with an available unit type. |
400 | BAD_REQUEST | Field: [field name] not allowed to update. | The request has attempted to set an attribute value that cannot be modified, such as totalVoiceCredits . |
400 | BAD_REQUEST | Request contains unrecognized field [field name]. | The request could not be processed because an attribute is invalid or unrecognized. The invalid value is provided when available. Correct the value and try again. This error may also be returned if the request attempts to perform an invalid operation. For example, the request has attempted to set an attribute value that cannot be modified, such as the jurisdictionHash . |
400 | BAD_REQUEST | Request contains incorrect field or value - {\[field name] | The request or an attribute in the request is incorrectly formatted or unknown. The incorrect value is provided when available. Correct the value and try again. |
400 | BAD_REQUEST | Role [role name] not allowed. | The request has attempted to set an administrator role that is not available. Retry with an available role. |
400 | BAD_REQUEST | Missing [field name]. | A mandatory attribute was not provided in the request. Add the value and try again. |
400 | BAD_REQUEST | Various. For example:
| The enabled value in the request is missing or is not set to Y . The enabled : Y value is required in requests to update attributes for the specified policy.Add the enabled : Y value and try again. |
400 | BAD_REQUEST | Missing [attribute] in [policy name] policy. | A mandatory attribute was not provided in the request for the specified policy. Add the attribute and try again. |
400 | BAD_REQUEST | Various. For example:
| The request attempted to set an attribute value for the specified policy that is incorrect or that is not available. Correct the value and try again. A field name is provided if there are multiple attributes in the policy. |
400 | BAD_REQUEST | SMS or Voice credentials must be enabled for defaultCountryCode policy. | The request attempted to enable the defaultCountryCode policy without also enabling an SMS or Voice authenticator. Enable one or both of these authenticators in this request and try again. |
400 | BAD_REQUEST | Invalid country code in defaultCountryCode policy. | The defaultCountryCode value provided in this request must be a two-digit ISO3166 country code. Correct the defaultCountryCode value and try again. |
400 | BAD_REQUEST | defaultValidityPeriod must be less than maxValidityPeriod in tempSecurityCode policy. | The request attempted to set the default validity period to be greater than the maximum validity period for the Temporary Security Code policy. Set the default validity period to less than or equal to the maximum validity period and try again. |
401 | BAD_REQUEST | Failed auth validation | Possible causes:
|
404 | Not Found | Possible causes:
| |
412 | BAD_REQUEST | Precondition Failed | The user ID provided in the request does not match a registered user. Verify that the user ID is correct and that the user is registered. |