The Notary Connect APIs use conventional HTTP response codes to indicate the success or failure of an API request. In general:

• Codes in the 2xx range indicate success.
• Codes in the 4xx range indicate an error based on the information provided (e.g., missing required fields, invalid token, resource not found).
• Codes in the 5xx range indicate an error on Snapdocs' servers (these are rare).

HTTP status codes

HTTP Code	Meaning	When You'll See It
200	OK	Successful GET request
201	Created	Successful POST request — a new order, attachment, comment
202	Accepted	Successful PUT request — an order was updated.
302	Found (Redirect)	Attachment download — redirects to a temporary download URL.
400	Bad Request	The request body is missing required fields or contains invalid data.
401	Unauthorized	The X-AUTH-TOKEN header is missing, the token is invalid, or the token has been revoked.
404	Not Found	The requested order, attachment, or resource does not exist or is not accessible with your API key.
422	Unprocessable Entity	The request was understood but contains semantic errors (e.g., invalid commenter email for comments).
500	Internal Server Error	An unexpected error occurred on Snapdocs' servers. If persistent, contact your Customer Success Manager.

Error response format

When an error occurs, the API returns a JSON object with error details. There are two response formats depending on the endpoint:

Standard error format (Orders, Attachments, Status, Products)

Most endpoints return errors in a meta.errors array:

{
  "meta": {
    "errors": [
      "Team Member is required",
      "Last name can't be blank"
    ]
  }
}

Comment error format

The Comments endpoint returns errors in a top-level errors array:

{
  "errors": [
    "commenter_email is required"
  ]
}

Getting help

If you encounter persistent errors or unexpected behavior:

• Check your API key type. Some endpoints are restricted to company keys only (status updates, listing comments).
• Verify reference IDs. Use the List clients endpoint to confirm that your product_id, team_member_id, and client_id values are valid.
• Contact your Snapdocs Customer Success Manager for assistance with account-specific issues or to request a new API key.