API Errors

Common Errors

400 - Bad Request

Nonce header is missing or invalid

All requests need to include an X-DFNS-NONCE header. See Request Headers for more information.

{
  "error": {
    "message": "request nonce is missing or invalid",
  }
}

Nonce already used

The nonce specified in X-DFNS-NONCE was already used. The nonce should be uniquely generated for every request.

{
  "error": {
    "message": "request nonce has already been used"
  }
}

User Action Signature already used

The User Action Signature specified in X-DFNS-USERACTION was already used. User action signatures can only be used once.

{
  "error": {
    "message": "user action has already been used"
  }
}

401 - Unauthorized

Caller not authenticated

All requests to an authenticated endpoint need to include a JWT in the Authentication header. See Request Headers for more information.

{
  "error": {
    "message": "user token is missing or invalid"
  }
}

403 - Forbidden

Caller not authenticated

Caller does not have access to the resource or endpoint

{
  "error": {
    "message": "CustomerEmployee us-24vwa-92s33-8tvqi1dg0a95megt is not authorized to perform operation (Auth:Apps:Update)"
  }
}

User Action Signature missing or invalid

Mutating requests need to include a valid User Action Signature in the X-DFNS-USERACTION header. See User Action Signing for more information.

{
  "error": {
    "message": "user action signature is missing or invalid"
  }
}

500 - Internal Server Error

Internal Server Error

This is an unexpected error. Please try your request again. If the call continues to fail, please contact support.

{
  "error": {
    "message": "Internal Server Error"
  }
}

Application Management Errors

Errors specific to the Application Management endpoints.

400 - Bad Request

Application cannot modify its own state

The application being deactivated needs to be different then the application specified in X-DFNS-APPID.

{
  "error": {
    "message": "application cannot modify its own state"
  }
}

404 - Not Found

Application not found

The specified application does not exist in the database.

{
  "error": {
    "message": "application not found"
  }
}

Credential Management Errors

Errors specific to the Credential Management endpoints.

Delegated Authentication Errors

Errors specific to the Delegated Authentication endpoints.

400 - Bad Request

User account has been deactivated

The user is deactivated

{
  "error": {
    "message": "User account has been deactivated."
  }
}

401 - Unauthorized

User not found

The user cannot be found in the system

{
  "error": {
    "message": "User not found"
  }
}

User Login Errors

Errors specific to the User Login endpoints.

400 - Bad Request

User account has been deactivated

The user is deactivated

{
  "error": {
    "message": "User account has been deactivated."
  }
}

401 - Unauthorized

User not found

The user cannot be found in the system

{
  "error": {
    "message": "User not found"
  }
}

User does not have a credential that can be used for the application

There is no valid credential for the user for this application

{
  "error": {
    "message": "User does not have a credential that can be used for the application."
  }
}

403 - Forbidden

Invalid code

The One Time Code provided is invalid

{
  "error": {
    "message": "Invalid code"
  }
}

Personal Access Token Management Errors

Errors specific to the Personal Access Token Management endpoints.

User Registration Errors

Errors specific to the User Registration endpoints.

400 - Bad Request

Registration code expired

The registration code being used is expired.

{
  "error": {
    "message": "Registration code expired"
  }
}

401 - Unauthorized

User already exists

The username used already exists in the system.

{
  "error": {
    "message": "User already exists."
  }
}

Service Account Management Errors

Errors specific to the Service Account Management endpoints.

User Action Signing Errors

Errors specific to the User Action Signing endpoints.

400 - Bad Request

User account has been deactivated

The user is deactivated

{
  "error": {
    "message": "User account has been deactivated."
  }
}

Challenge token is not valid

The token being used is not valid

{
  "error": {
    "message": "Challenge token is not valid."
  }
}

401 - Unauthorized

User not found

The user cannot be found in the system

{
  "error": {
    "message": "User not found"
  }
}

User does not have a credential that can be used for the application

There is no valid credential for the user for this application

{
  "error": {
    "message": "User does not have a credential that can be used for the application."
  }
}

User Management Errors

Errors specific to the User Management endpoints.

User Recovery Errors

Errors specific to the User Recovery endpoints.

401 - Unauthorized

Credential cannot be used as a recovery factor

The credential being used is not a recovery credential

{
  "error": {
    "message": "Credential cannot be used as a recovery factor."
  }
}