User Register Reference

This defines the User Register API:

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

Request

A Fax API request looks like:

https://fax.to/api/v2/user

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 user. Yes
password The password of the registered user No

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": "f1a99500-7ce0-11e7-9fb1-0580e1fcb90c"
}

Keys and Values

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

Response Messages

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