node-authy
Authy and Verify API Client for Node.js written by Adam Baldwin.
Installation
npm install authy
When in doubt check out the official Authy and Verify docs.
Usage
Requiring node-authy
var authy = 'APIKEY';
Send OneTouch
OneTouch API docs are the source of truth. send_approval_request(id,user_payload,hidden_details,logos,callback)
authy;
- id is the Authy id.
- user_payload: { 'message': 'user message here', ['details': {...}] }
- hidden_details: optional
- logos: optional
Check Approval Status
check_approval_status (uuid,callback)
authy;
Register New User
register_user(email, cellphone, [country_code], [send_install_link_via_sms], callback);
authy;
If not given, country_code
defaults to "1"
and send_install_link_via_sms
defaults to true
.
Verify Token
verify(id, token, [force], callback);
authy;
Request SMS
request_sms(id, [force], callback);
authy;
=======
request_call(id, [force], callback);
authy;
Delete Registered User
delete_user(id, callback);
authy;
Get Registered User Status
user_status(id, callback);
authy;
Start Phone Verification
Browse the API docs for all available params.
phones().verification_start(phone_number, country_code, params, callback);
authy;
The params
argument is optional and sets 'sms' as the default via
, leaving the other two options blank.
Check Phone Verification
Browse the API docs for all available params.
phones().verification_check(phone_number, country_code, verification_code, callback);
authy;
Status of Phone Verification
Browse the API docs for all available params.
phones().verification_status(phone_number, country_code, callback);
authy;