Permalink
Browse files

Add cellphone match documentation

  • Loading branch information...
danpal committed Nov 7, 2012
1 parent 0c39e10 commit 4fa36cb328c28d53f29a8aec8b08502b6ee8b670
Showing with 4 additions and 0 deletions.
  1. +4 −0 README.md
View
@@ -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.

0 comments on commit 4fa36cb

Please sign in to comment.