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": "Not Authorized."
  }
}

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.

User Login Errors

Errors specific to the User Login endpoints.

Personal Access Token Management Errors

Errors specific to the Personal Access Token Management endpoints.

User Registration Errors

Errors specific to the User Registration endpoints.

Service Account Management Errors

Errors specific to the Service Account Management endpoints.

User Action Signing Errors

Errors specific to the User Action Signing endpoints.

User Management Errors

Errors specific to the User Management endpoints.

User Recovery Errors

Errors specific to the User Recovery endpoints.

Last updated