/ 
Finance-Robinhood-0.92_003
River stage zero No dependents
/ Finance::Robinhood::Error::Challenge

NAME

Finance::Robinhood::Error::Challenge - Device Authentication

SYNOPSIS

$challenge->respond( 284750 );
$challenge || die; # false value is retured when the challenge response has not been validated

DESCRIPTION

As a security measure, Robinhood has implemented user-involved client validation. When met with a challenge, the user must respond with a six digit string of numbers sent to them via SMS or email within a certain length of time. Failing to respond or failing to respond with the correct numbers blacklists the device from accessing the user's account.

Challenge objects evaluate to untrue values if the response was invalid or if the challenge has not been responded to yet. Obviously, they evaluate to true values if the challenge was met successfully.

METHODS

id( )

UUID of the challenge request.

user( )

UUID of the currently or attempting to log in.

type( )

Current primary means of sending validation key.

alternate_type( )

Alternate means of sending validation key.

remaining_retries( )

The number of times the system will attempt to deliver the validation key.

remaining_attempts( )

The number of times the user has to verify before the device ID is blocked.

status( )

return 'OK' if $challenge->status eq 'validated';

Returns whether the challenge has been issued, validated, etc.

expires_at( )

$challenge->expires_at;

Returns a Time::Moment object. This value should be 5 minutes in the future which is how long you have to respond( ... ) to the challenge.

email( )

$challenge->email;

Request that the system sends the authorization key via email to the address on file.

sms( )

$challenge->sms;

Request that the system sends the authorization key via SMS to the phone number on file.

respond( ... )

$challenge->respond( 003298 );

Respond to the challenge with the string sent to you via SMS or email.

LEGAL

This is a simple wrapper around the API used in the official apps. The author provides no investment, legal, or tax advice and is not responsible for any damages incurred while using this software. This software is not affiliated with Robinhood Financial LLC in any way.

For Robinhood's terms and disclosures, please see their website at https://robinhood.com/legal/

LICENSE

Copyright (C) Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under the terms found in the Artistic License 2. Other copyrights, terms, and conditions may apply to data transmitted through this module. Please refer to the LEGAL section.

AUTHOR

Sanko Robinson <sanko@cpan.org>