Error Codes

Overview

Our system returns structured error responses to help developers and users understand what went wrong and how to resolve the issue. These errors are typically returned in JSON format and include error codes, messages, and metadata.

Error Response Structure

A typical error response follows this format:

{
    "responseStatus": {
        "errorCode": "ERROR_IDENTIFIER",
        "message": "A human-readable description of the error",
        "errors": [
            {
                "errorCode": "SPECIFIC_ERROR_CODE",
                "fieldName": "Field where the error occurred",
                "message": "Detailed error message",
                "meta": {
                    "AdditionalContext": "Further details about the error"
                }
            }
        ]
    }
}

Example

Here’s an example of an error when a signee does not have a valid mobile certificate on their mobile phone:

{
    "responseStatus": {
        "errorCode": "NOT_A_MOBILE_SIGNATURE_USER",
        "message": "No mobile certificate found for Ssn: 1111111119, Phone number: 1234567",
        "errors": [
            {
                "errorCode": "NOT_A_MOBILE_SIGNATURE_USER",
                "fieldName": "CreateSigningProcesses[0].CreateSignees[0].PhoneNumber",
                "message": "No mobile certificate found for Ssn: 1111111119, Phone number: 1234567",
                "meta": {
                    "Ssn": "1111111119",
                    "PhoneNumber": "1234567",
                    "PropertyName": "Phone Number",
                    "PropertyValue": "1234567",
                    "CollectionIndex": "0"
                }
            }
        ]
    }
}

Error object properties

Field	Description
errorCode	A unique identifier for the error. Helps developers handle specific cases programmatically.
message	A human-readable explanation of what went wrong.
errors	A list containing more details about specific fields that caused the error.
fieldName	The exact field where the error occurred in the request.
meta	Additional metadata about the error, such as user input values or collection indices.

Common Error Codes Examples

When handling errors in our system, refer to the table below for common error codes, their descriptions, and suggested resolutions.

Error Code	Description	Suggested Fix
NOT_A_MOBILE_SIGNATURE_USER	No valid mobile certificate found for the user.	Ensure the user has a registered mobile certificate.
SMS_SIGNUP_NOT_SUPPORTED	SMS signup is not supported for the phone number, or SignatureType is not Qualified.	Change the CommunicationDeliveryType from SMS if SignatureType is Simple or ClickToSign.
INVALID_INPUT	A provided field has incorrect data.	Verify the format and constraints of the input.
MISSING_REQUIRED_FIELD	A mandatory field is missing.	Check the request body and add the required field.
UNAUTHORIZED_ACCESS	The request is not authorized.	Ensure the correct authentication credentials are used.
RESOURCE_NOT_FOUND	The requested resource does not exist.	Verify the resource identifier (e.g., user ID, process key).