Errors

Errors return both an HTTP status code and an error message. Errors caused by the client return a 4xx Client Error status code. Errors caused by the API service return a 5xx Server Error status code.

Example error response

{
  "errors": [
    {
      "code": "<error_code>",
      "message": "<error_message>"
    }
  ]
}

Response parameters

NameTypeDescription
errorsarrayList of errors from the request.
.. codestringError code identifying a specific error.
.. messagestringDescription of the error.

4xx Client Error codes

StatusCodeDescription
429request_limit_exceededService unavailable, please limit request volume. See Rate limits.
404not_foundGeneric 404 message. Make sure the endpoint URL is properly constructed.
404not_foundorder
404not_foundproduct
404not_foundroute
403access_deniedmissing_permission
400ambiguous_productThe product.type_hint value could not be used to determine a product. See Submit order – Request parameters table.
400auth_key_exists_for_accountAn AuthKey has already been created for your account.
400bad_request_formatThe request body is malformed. Make sure the request body uses valid JSON or XML.
400caa_check_failedvariable
400caa_not_foundvariable
400cannot_activate_domain_lockCannot activate domain locking for the domain. Enable domain locking for your account and try again.
400cannot_archive_primary_certificateThe primary certificate on an order cannot be archived. In your Archive certificate request, make sure the certificate ID is not for the primary certificate on an order and try again.
400cannot_deactivate_domain_lockCannot deactivate domain locking for the domain. Enable domain locking for your account and try again.
400cert_transparency_turned_off_for_accountCT logging has been disabled for your CertCentral account. An administrator must enable this feature.
400cert_validity_exceeds_order_validityThe validity period of the certificate cannot exceed the validity period of the order.
400csr_invalid_cannot_parseThe CSR is not in the correct format, is missing required fields, or contains fields with invalid characters. See Create a CSR
400csr_invalid_key_size_client_certThe CSR for the client certificate has too small a key. An RSA CSR for a client certificate must have a key size of 2048, 3072, or 4096.
400csr_invalid_key_size_code_signingCSRs for code signing certificates must be ECC P-256 or RSA 3072-bit key sizes or larger. Generate a new CSR and submit another request.
400csr_not_allowedThe specified product does not use a CSR. See Glossary – CSR requirements.
400csr_safenet_cc_invalid_csr_key_sizeCSR key size is not compatible with the hardware token in the request. SafeNet eToken 5110 CC hardware tokens require CSRs with an RSA 4096 or ECC P-256 key. Generate a new CSR with a compatible key size.
400csr_safenet_fips_requires_ecc_keyCSR key size is not compatible with the hardware token in the request. SafeNet eToken 5110 FIPS hardware tokens require CSRs with an ECC key. Generate a new CSR with an ECC key type or request the certificate for a platform that is compatible with your CSR (see Glossary – EV Code Signing Certificates).
400ct_logging_disabledCT logging has been disabled for your CertCentral account. An administrator must enable this feature.
400custom_expiration_not_allowedAllowed validity periods are configured for the product type. Remove the restrictions to allow custom expiration dates.
400disabled_domainThe submitted domain is deactivated. You must activate the domain before you can submit it. See Activate domain.
400dns_entry_missingvariable
400dns_internal_errorvariable
400dns_invalid_domainvariable
400dns_invalid_entryvariable
400dns_lookup_timeout_caavariable
400dns_mismatchvariable
400domain_lockedvariable
400domain_not_allowedDomain restrictions are configured for the specified container.
400domains_not_prevalidatedvariable
400email_domain_not_validatedEmail must have a validated domain.
400email_not_valid_email_formatThe submitted email address is not valid. Make sure the submitted email address follows standard email address conventions.
400file_incorrect_contentvariable
400file_invalid_formatvariable
400file_not_foundvariable
400file_outdated_contentvariable
400file_random_value_not_foundUnable to find the random value at the expected file location for the domain. Make sure:
400file_server_not_reachablevariable
400inactive_organizationThe submitted organization is deactivated. Activate the organization or specify a different organization. See Activate organization.
400internal_data_check_failedvariable
400internal_names_not_allowed
400invalid_caa_entryvariable
400invalid_ca_cert_idThe specified Certificate Authority is not valid.
400invalid_chars:<param.name>The specified parameter contains invalid characters. Refer to the endpoint’s Response parameters table for valid input characters.
400invalid_cname_whitelistvariable
400invalid_cname_validationvariable
400invalid_common_name_on_duplicateThe common name on duplicate requests must match what was on the original order. Refer to the original order for the correct common name.
400invalid_wildcard_dcv_methodThe DCV method in the request (http-token) cannot be used to validate wildcard domain names. Submit the request using another supported DCV method. For more information, see File-based domain control validation (http-token).
400invalid_dns_cnamevariable
400invalid_dns_methodThe DCV method for the order is set to email.
400invalid_dns_name_on_duplicateThe DNS name on duplicate requests must match what was on the original order. Refer to the original order for the correct DNS name.
400invalid_dns_txtUnable to find a valid DNS TXT record for the domain. Make sure:
400invalid_payment_methodThe specified payment method is not enabled. To use the specified payment request, you must enable it in your account.
400invalid_value:<param.name>The specified parameter contains an invalid value. Refer to the endpoint’s Response parameters table for valid input values.
400invalid_value:validity_yearsThe specified parameter contains an invalid value for the time span allowed.
This can occur when the number of years specified is not permitted because the span exceeds what the order allows (for example, more than three years for a code signing certificate), or what is set as the limit at the account level by an admin.
Additionally, this error may occur when the order validity is set with a custom_expiration_date and an admin for the account has already applied a limit to the allowed order validity period. When an admin applies this limit, the option to set a custom expiration date is disabled for the product using order_validity.days or order_validity.custom_expiration.date.
400malformed_cname_targetvariable
400missing_ca_cert_idThe certificate authority ID is required for this request. Specify the certificate authority to issue the certificate from and resend your request.
400missing_dns_name_on_duplicateThe DNS name is missing from the request. DNS names cannot be removed on duplicate orders. Resend the request with the DNS name included.
400missing_request_dataNo body was sent with the request. Refer to the endpoint’s documentation for request requirements.
400missing_required_custom_fieldThe request body is missing a required custom field. To get a list of custom order field metadata for your account, see List custom fields.
400no_private_ca_enabledNo private certificate authorities are enabled for the account.
400not_allowed_to_change_ct_setting_per_orderThe per certificate order feature has not been activated for your CertCentral account. An administrator must enable this feature.
400note_contains_private_keyNever share private keys with any third party, including DigiCert. Remove the private key and try again.
400order_not_eligible_for_duplicateDuplicates are not allowed for the specified order.
400order_not_eligible_for_renewalOrder not eligible for renewal.
Returned for SSL certificate order requests when the order to renew (renewal_of_order_id) is not within the renewal window. Wait until the order is within the renewal window and try again.
400order_renewed_alreadyOrder not eligible for renewal.
Returned for SSL certificate order requests when the order to renew (renewal_of_order_id) has already been renewed.
An order can only be renewed once. Submit a new certificate order request, or use the Order info API to get the order ID of the renewed order (was_renewed_by_order_id).
400other_domain_on_wildcardAll SANs on a wildcard certificate must have the same common name. Either change the SANs to use the same common name or order a multi-domain certificate.
400pending_account_merge_completionDigiCert is processing a request to merge the account that sent the request with another CertCentral account. While the merge is in progress, the accounts being merged cannot:
To perform these operations, wait until the merge is complete. Submit a new request from the account that persists after the merge.
400pending_reissueA previous reissue request is still pending for the order. You must reject or approve and issue the pending request before a new reissue request can be placed.
400product_name_limit_exceededYou have exceeded the number of names allowed on this product.
400product_not_allowedThis product is not allowed.
400protected_domainOne or more domains listed on this certificate request are protected by the domain owner. Modify the domains and resubmit the request.
400required_param:The specified parameter is required. Refer to the endpoint’s Response parameters table to identify required and optional parameters.
400rfc5280_common_name_invalidThe submitted common name does not conform to industry standards.
400rfc5280_common_name_too_longCommon name must be less than 64 characters in order to be compliant with industry standards.
400rfc5280_org_unit_too_longOrganization units must be less than 64 characters in order to be compliant with industry standards.
400rfc5280_org_name_too_longOrganization name total length (including Assumed Name for EV certificates) must be less than 64 characters in order to be compliant with industry standards.
400rfc5280_address_field_too_longAddress fields must be less than 64 characters in order to be compliant with industry standards.
400rfc5280_org_unit_invalidThe org unit field contains an invalid value according to industry standards.
400rfc5280_org_invalidOne or more fields on the organization contains invalid values according to industry standards.
400va_not_eligible_orderThe request failed for one of the following reasons:
400va_not_eligible_productThe request failed because the product does not support vulnerability assessments.
For a list of products that support vulnerability assessments, see Vulnerability assessments – Supported products.
400va_order_not_foundNo data found for the submitted request. Make sure you are using the correct order ID, then try again.
400va_order_already_enabledVulnerability assessments are already enabled for the order.
400va_order_not_enabledVulnerability assessments are not enabled for the order. Make sure you are using the correct order ID and that vulnerability assessments are enabled, then try again.
400va_domain_not_foundThe domain in the request is not included on the specified order. Make sure you are using the correct domain and order ID, then try again.
400va_email_recipient_not_foundNo email recipient found on the order.
400va_bad_requestThe request is not formatted correctly. Make sure the filter parameters and URL query strings in your request are formatted correctly, then try again.
400vmc_logo_unable_to_decodeLogo could not be decoded. Use one of these endpoints to make sure the logo meets formatting requirements for VMC, and then try again:
400vmc_logo_size_exceededvariable
400need_vmc_logoTo add or modify trademark details, you must first upload a logo for the order. New VMC order requests can only include a trademark country code or registration number if they also include a logo. If you receive this error when submitting a new VMC order request, do one of the following:
400cannot_modify_approved_logoThe logo is already validated and approved. You cannot change the trademark country code or registration number for an approved VMC logo.
400order_not_pendingRequested operation can only be performed on orders with a pending status.
400invalid_vmc_logoLogo does not meet the formatting requirements for VMC certificates. Fix the formatting issues described in the error message and try again.
400username_unavailableThe specified username is not available.
400user_cannot_access_organizationThe user does not have access to the organization.