Warnings and Errors

If an error or warning occurs, we’ll return either an error or warning object in the JSON response. These can also be viewed in the API Reference documentation.

Example Warning

A response may contain one or more warnings. Check out the list of warning names below to learn more about the possible values of warning_name and their meaning. Here is an example of the JSON structure of the response:

1
{
2
    "warnings": [
3
        {
4
            "warning_msg": "This SignatureRequest will be placed on hold until the user confirms their email address.",
5
            "warning_name": "unconfirmed"
6
        }
7
    ]
8
}

Warning Names

List and details of possible warnings that can be returned.

Example Error

A response may only contain one error at most. Check out the list of error names below to learn more about the possible values of error_name and their meaning. Here is an example of the JSON structure of the response (or error POSTed to your callback url):

1
{
2
    "error": {
3
        "error_msg": "Unauthorized user.",
4
        "error_name": "unauthorized"
5
    }
6
}

Error Names

List and details of possible errors that can be returned.