Common errors & supporting your customers.

Common Errors

Signup

EndpointError ScenarioCodeCause
SignupMissing partner400A partner name has not been provided (Mandatory)
SignupMissing first name400A first name has not been provided (Mandatory)
SignupMissing last name400A last name has not been provided (Mandatory)
SignupMissing email400An email has not been provided (Mandatory)
SignupMissing portfolio name400A business/portfolio name has not been provided (Mandatory)
SignupMissing external ID400An external name has not been provided for the business (Mandatory)
SignupDuplicated external ID400A Deputy account is already linked to this external ID
SignupDuplicated user email400Can't create user - this email already has a Deputy account. Please reach out to the Deputy team.
SignupInternal Error500Something went wrong - please reach out to the Deputy team.
SignupError in provisioning partner500Something went wrong - please reach out to the Deputy team.

Change Plan

EndpointError ScenarioCodeReason
Change-planAttempted upgrade on a converted account400Only accounts in downgraded or cancelled trials may be converted.
Change-planAttempted cancellation on a free/non converted account400Only accounts in downgraded or cancelled trials may be converted.
Change-planAttempted conversion or cancellation on an non embedded account400Only accounts that are created by a specific embedded partner can be upgraded/downgraded by that embedded partner
Change-planAttempted cancellation on an invalid hostname.400Hostname provided must be a valid Deputy URL

Error Format

Errors will be returned consolidated as part of a unsuccessful response.

{
    "success": false,
    "error": {
        "code": 400,
        "message": "Invalid request payload",
        "details": [
            {
                "type": "BAD_REQUEST",
                "bad_request": {
                    "field_violations": [
                        {
                            "field": "businessData.estimatedEmployeeCount",
                            "description": "Estimated employee count should be greater than 0"
                        },
                        {
                            "field": "userData.firstName",
                            "description": "A first name is required."
                        },
                        {
                            "field": "businessData.portfolioName",
                            "description": "A portfolio name is required."
                        },
                        {
                            "field": "businessData.externalId",
                            "description": "An External ID is required."
                        }
                    ]
                }
            }
        ]
    }
}

πŸ“˜

Supporting your users

In embedded partner relationships, partners take on the responsibility of supporting their customers.

To properly debug a customer that is encountering an issue, it is recommended that the partners support team adds a privileged user (possible via a call to our add people API).

If this user is created and removed before the end of the month, it will not incur a charge.