Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit docs to reflect changes with the is_phone_verfication_required parameter #656

Merged
merged 3 commits into from
Dec 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 4 additions & 13 deletions content/pages/sign/30-request-options/20-extra-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@ rank: 2
# Extra security (2FA)

Imagine you want an [additional layer of security][2FA] for your signature
requests, by requesting the signer to use a password or a phone verification
requests, by requesting the signer to use a password or a phone verification
in the document signing step.

![2FA Signature request](images/sign-flow-2fa.png)

## Phone verification

You can require the signer to use 2FA through their mobile phone to complete
the signature request by passing the `is_phone_verification_required_to_view`
parameter.
the signature request by passing the `verification_phone_number` parameter on the signer along with their phone number.

For example:

Expand Down Expand Up @@ -98,22 +97,14 @@ def main():
</Tab>
</Tabs>

When the signer tries to complete the signature request a phone verification
pops up:
When the signer tries to access the signature request a phone verification dialog pops up:

![Phone verification](images/sign-simple-phone-verification.png)

Then the signer is prompted to enter the code sent in a SMS:
Then the signer is prompted to enter the code sent in an SMS:

![Entering the SMS code](images/sign-simple-phone-verification-enter-code.png)

<Message size='small'>

This check is done as the last step, so it does not prevent the signer from
accessing the document.

</Message>

## Password verification

You can require the signer to use a password to open the signature request
Expand Down
Loading