Syniverse MFA API documentation version 1.0.0

https://api.syniverse.com/mfa/v1

About Syniverse MFA

The purpose of this specification is to describe the Syniverse MFA API. The Syniverse MFA service is intended to be a REST API-based multi-factor authentication engine. Through the MFA apis, the calling appication can associate users with MDNs, validate the MDNs, send MFA authentication PINs to the users and validate the PINs when entered by the user.

Application

This resource represents the customer application that is using the MFA service for authentication. It conatins the configurations that drive the MFA behavior. It also contains sub-resources that are used in the MFA flows.

Resource attributes:

  • id (string): Unique id of the sender class

  • name (string): The name of the appication.

  • description (string): The description for the Application.

  • auth_code_length (integer): The length of the authentication token that will be used for authentication.

  • auth_token_type (string): NUMERIC, ALPHANUMERIC, ALPHA, COMPLEX

  • auth_token_validity_duration (integer): The number of seconds that the authentication token should remain valid.

  • auth_token_prefix (string): A prefix that will be included with each authentiation token.

  • auth_token_delivery_methods (string): SMS

  • associate_template (string): An inline template or template id to be used to send mdn assosiation validation code. If empty a default template will be used

  • display_name (string): String to be used as value of $display_name parameter in validation and login templates

  • login_template (string): An inline template or template id to be used to send login validation code. If empty a default template will be used

  • message_from (string): The SCG sender ID to be used when sending authentication token messages for this appication.

  • created_date (date): The date the resource was created

  • last_updated_date (date): The data the resource was last changed

  • version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/applications get post

Returns the list of applications

Query Parameters

  • id: (string)

    Filter

  • name: (string)

    Filter

  • auth_code_length: (integer)

    Filter

  • auth_token_type: (string)

    Filter

  • auth_token_validity_duration: (integer)

    Filter

  • auth_token_prefix: (string)

    Filter

  • auth_token_delivery_methods: (string)

    Filter

  • message_from: (string)

    Filter

  • created_date: (date)

    Filter

  • last_updated_date: (date)

    Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Application List",
  "type": "array",
  "items": {
    "title": "Application",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "auth_code_length": {
        "type": "integer"
      },
      "auth_token_type": {
        "type": "string"
      },
      "auth_token_validity_duration": {
        "type": "integer"
      },
      "auth_token_prefix": {
        "type": "string"
      },
      "auth_token_delivery_methods": {
        "type": "string"
      },
      "associate_template": {
        "type": "string"
      },
      "display_name": {
        "type": "string"
      },
      "login_template": {
        "type": "string"
      },
      "message_from": {
        "type": "string"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Creates a new application

Body

Type: application/json

Form Parameters
  • name: (string)
  • description: (string)
  • auth_code_length: (integer)
  • auth_token_type: (string)
  • auth_token_validity_duration: (integer)
  • auth_token_prefix: (string)
  • auth_token_delivery_methods: (string)
  • associate_template: (string)
  • display_name: (string)
  • login_template: (string)
  • message_from: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/applications/{Application_ID} get delete

The application resource assoacitated with this ID

Returns the current version of the specified Application

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

Query Parameters

  • id: (string)

    Filter

  • name: (string)

    Filter

  • auth_code_length: (integer)

    Filter

  • auth_token_type: (string)

    Filter

  • auth_token_validity_duration: (integer)

    Filter

  • auth_token_prefix: (string)

    Filter

  • auth_token_delivery_methods: (string)

    Filter

  • message_from: (string)

    Filter

  • created_date: (date)

    Filter

  • last_updated_date: (date)

    Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Application",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "auth_code_length": {
      "type": "integer"
    },
    "auth_token_type": {
      "type": "string"
    },
    "auth_token_validity_duration": {
      "type": "integer"
    },
    "auth_token_prefix": {
      "type": "string"
    },
    "auth_token_delivery_methods": {
      "type": "string"
    },
    "associate_template": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "login_template": {
      "type": "string"
    },
    "message_from": {
      "type": "string"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Deletes the Application resource with the specified ID

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

User

This resource stores the information of a MFA user. This includes the MDN and MDN validation status. An MDN must be validated bedore it can be used for authentication.

Resource attributes:

  • id (string): Customer Supplied User ID

  • user_address (string): human readable description of the sender address type

  • status (string): The status of the MDN. The possible values are- INITIAL, VALIDATION PENDING, VALIDATED

  • created_date (date): The date the resource was created

  • last_updated_date (date): The data the resource was last changed

  • version_number (integer): An ascending version number of the resource. 1 upon creation, incremented by one for each modification done. Used to implement optimisitic locking

/applications/{Application_ID}/users get

Returns the list of Users

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

Query Parameters

  • id: (string)

    Filter

  • status: (string)

    Filter

  • created_date: (date)

    Filter

  • last_updated_date: (date)

    Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "User List",
  "type": "array",
  "items": {
    "title": "User",
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "user_address": {
        "type": "string"
      },
      "status": {
        "type": "string"
      },
      "created_date": {
        "type": "date"
      },
      "last_updated_date": {
        "type": "date"
      },
      "version_number": {
        "type": "integer"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/applications/{Application_ID}/users/{User_ID} get delete

The User resource associated with the provided ID

Returns the current version of the specified User.

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

  • User_ID: required (string)

    This is the unique identifier of the User resource.

Query Parameters

  • id: (string)

    Filter

  • status: (string)

    Filter

  • created_date: (date)

    Filter

  • last_updated_date: (date)

    Filter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "User",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "user_address": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "created_date": {
      "type": "date"
    },
    "last_updated_date": {
      "type": "date"
    },
    "version_number": {
      "type": "integer"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Deletes the User resource with the specified ID

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

  • User_ID: required (string)

    This is the unique identifier of the User resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/applications/{Application_ID}/users/{User_ID}/associate post delete

Posting to this resource will trigger the start of the user address validation flow.

Associates an user address (MDN or whatever) with the User. Also creates and sends a validation token to the end user. The post body will contain the user address (MDN, etc.).

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

  • User_ID: required (string)

    This is the unique identifier of the User resource.

Body

Type: application/json

Form Parameters
  • display_name: (string)
  • address: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Removes the association with this User.

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

  • User_ID: required (string)

    This is the unique identifier of the User resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/applications/{Application_ID}/users/{User_ID}/validate post

Posting to this resource will validate a given validation code.

Validates the association or login process using the last supplied validation code. The post body will contain the validation code.

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

  • User_ID: required (string)

    This is the unique identifier of the User resource.

Body

Type: application/json

Form Parameters
  • validation_code: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

  • 2001 - Invalid Authentication Code - The received authentication code is not valid.
  • 2002 - Authentication Code Expired - The authentication code has expired. A new one should be requested.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

/applications/{Application_ID}/users/{User_ID}/login_start post

Posting to this resource will trigger the start of the MFA login flow.

Creates and sends a MFA validation code to the end user.

URI Parameters

  • Application_ID: required (string)

    This is the unique identifier of the Application resource.

  • User_ID: required (string)

    This is the unique identifier of the User resource.

Body

Type: application/json

Form Parameters
  • display_name: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • 400 - The Error message provides information about what's wrong with the request - The request was formated incorrectly or contained invalid data
  • 1023 - Indexed field too long - One of the values in the request exceeded the maximum allowed length

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

  • 401 - Unauthorized - Provided authentication data is invalid or insufficient

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

  • 402 - Insufficient credit - The account does not have sufficeint funds for this operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • 403 - Forbidden - Access to this resource is not allowed with the current application token

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

  • 1001 - Stale data - Concurrent resource update. Refresh the resource and retry.
  • 1011 - The Error message provides details about the key being violated - Unique key constraint violated
  • 2003 - User MDN not validated - The user's MDN must have been validated. MDN should be validated before login.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

  • 2004 - User sent too many requests - User sent too many requests.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

  • 500 - Server Error - Internal server error. Please report

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.