Sub User API Reference

This defines the Sub User API:

  • Request - Creates a Sub User.
  • Response - ensure that your request to the Fax API was successful.

Request

A Fax API request looks like:

https://fax.to/api/v2/subuser?api_key=API_KEY

This request contains:

Parameters

The following table shows the parameters you use in the request:

Parameter Description Required
email The unique email id of the subuser. Yes
password The password of the subuser No

Authentication information

The following table shows the information for authentication:

Parameter Description Required
api_key Your Key. For example, api_key=f@x2r0ckkz. Yes.

You find your Key in Dashboard.

Security

To ensure privacy, you must use HTTPS for all Faxto API requests.

Encoding

You submit all requests with a POST call using UTF-8 encoding and URL encoded values.

Response

We support JSON ONLY responses


{
  "status": "success",
  "api_key": "94a126a0-9940-11e7-ac09-f55a41e16868"
}

Keys and Values

Key Value Response Type
status The status of the API request JSON
api_key The API key of the subuser JSON

Response Messages

HTTP Status Code Reason
200 Successful response
401 Unauthorized.
403 Rate limit exceeded
404 Resource not Found
500 Internal server error