Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs


Authentication and permission problems return access_denied with a message that names the cause. If you get no response at all, check the header first: Miva doesn’t answer requests that are missing the X-Miva-API-Authorization header or that spell its name differently.

For signing problems, start with Common signing mistakes.

The following error responses revolve around Authentication and Permissions. Its important to note that if you do not pass the Miva X-Miva-API-Authorization header or its name is incorrect, no response will be given.

Access Denied#

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Access denied"
}

An access denied error could be for any of the following reasons:

  1. Invalid Access Token
  2. Missing Header Type or Type mismatch
  3. Invalid Content Type
  4. IP address is not whitelisted
  5. Access Token does not have sufficient privileges

Access Denied - Invalid Request Signature#

This means that you passed a header type where Miva is expecting a request signature, but you are either not sending one, or the signature is incorrect.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Invalid request signature"
}

Access Denied - Missing required timestamp#

This means that your Access Token is configured to require a timestamp in the JSON body, but you are not passing one.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Missing required timestamp"
}

Access Denied - Timestamp outside Configured Window#

This means that your timestamp in the JSON body is outside of the configured time set for the Access Token.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Timestamp outside configured window"
}

Access Denied - Invalid Content Type#

Your request must pass a content type of “application/json”

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Invalid request content type"
}

Access Denied - Invalid Request Method#

Your request must use http method type of “POST”. GET and other method types are not supported.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Invalid request method"
}

Access Denied - Token does not require timestamp#

This message will appear when the token does not have the require timestamp setting checked.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Token does not require timestamp"
}

Access Denied - Token does not require signature#

This message will appear when the token does not have the require signature.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Token does not require signature"
}

Access Denied - Function not assigned to token#

This message will appear when the function has not been assigned to the token.

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "Function not assigned to token"
}

Access Denied - Token Disabled#

This message will appear when the API Token is disabled. (Added in Version 10.10.01)

{
    "success": 0,
    "error_code": "access_denied",
    "error_message": "API token is disabled"
}