Skip to content
This repository has been archived by the owner on Apr 3, 2019. It is now read-only.

Commit

Permalink
fix(docs): Add notes for sms (#184), r=@shane-tomlinson
Browse files Browse the repository at this point in the history
  • Loading branch information
vbudhram committed Mar 9, 2017
1 parent d84f289 commit 1cd55b1
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,18 @@ Failing requests may be due to the following errors:
## POST /check

Called by the auth server before performing an action on its end to
check whether or not the action should be blocked.
check whether or not the action should be blocked. The endpoint is
capable of rate-limiting and blocking requests that involve a variety
of [actions](https://github.com/mozilla/fxa-customs-server/blob/master/lib/actions.js).

___Parameters___

* email - the email address associated with the account
* ip - the IP address where the request originates
* action - the name of the action under consideration
* headers - the forwarded headers of the original request
* payload - the payload of the original request
* phoneNumber - optional phone number of request

### Request

Expand Down

0 comments on commit 1cd55b1

Please sign in to comment.