Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add cellphone match documentation

  • Loading branch information...
commit 4fa36cb328c28d53f29a8aec8b08502b6ee8b670 1 parent 0c39e10
@danpal danpal authored
Showing with 4 additions and 0 deletions.
  1. +4 −0 README.md
View
4 README.md
@@ -12,6 +12,10 @@ Ruby library to access the Authy API
## Registering a user
+__NOTE: User is matched based on cellphone and country code not e-mail.
+A cellphone is uniquely associated with an authy_id.__
+
+
`Authy::API.register_user` requires the user e-mail address and cellphone. Optionally you can pass in the country_code or we will asume
USA. The call will return you the authy id for the user that you need to store in your database.
Please sign in to comment.
Something went wrong with that request. Please try again.