Clarify the OTP flow in Sage Bank Feeds connection flow#1797
Clarify the OTP flow in Sage Bank Feeds connection flow#1797pzaichkina merged 5 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| Next, make the data connection ID from step two (above) available to the SMB user by, for example, surfacing the ID in your application. They'll need to enter this ID when connecting a bank account to Sage, as described in the next procedure. | ||
|
|
||
| ## Surface the One-Time Password (OTP) to the user |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Headings] 'Surface the One-Time Password (OTP) to the user' should use sentence-style capitalization.
|
|
||
| Next, make the data connection ID from step two (above) available to the SMB user by, for example, surfacing the ID in your application. They'll need to enter this ID when connecting a bank account to Sage, as described in the next procedure. | ||
|
|
||
| ## Surface the One-Time Password (OTP) to the user |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
|
|
||
| ## Surface the One-Time Password (OTP) to the user | ||
|
|
||
| In order to authenticate the connection, your user will be asked to submit a One-Time Password. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.
|
|
||
| ## Surface the One-Time Password (OTP) to the user | ||
|
|
||
| In order to authenticate the connection, your user will be asked to submit a One-Time Password. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be asked').
| ``` | ||
| GET https://api.codat.io/companies/{{companyId}}/connections/{{dataConnectionId}}/bankFeeds/otp | ||
| ``` | ||
| Surface the OTP in your application in a place where your user can retrieve it later as part of the connection flow. |
There was a problem hiding this comment.
[Google.WordList] Use 'app' instead of 'application'.
|  | ||
|
|
||
| 5. If the SMB user was authenticated with Codat successfully, a dialog listing the available source bank accounts (created using the `POST / bankFeedAccounts` endpoint) is displayed. For example: | ||
| 4. If the SMB user was authenticated with Codat successfully, a dialog listing the available source bank accounts (created using the `POST / bankFeedAccounts` endpoint) is displayed. For example: |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('was authenticated').
|  | ||
|
|
||
| 5. If the SMB user was authenticated with Codat successfully, a dialog listing the available source bank accounts (created using the `POST / bankFeedAccounts` endpoint) is displayed. For example: | ||
| 4. If the SMB user was authenticated with Codat successfully, a dialog listing the available source bank accounts (created using the `POST / bankFeedAccounts` endpoint) is displayed. For example: |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is displayed').
| 5. The SMB user selects the bank account they want to connect, then clicks **OK**. | ||
|
|
||
| 7. The SMB user is redirected to the Sage product from which they started the connection flow. | ||
| 6. The SMB user is redirected to the Sage product from which they started the connection flow. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is redirected').
a-diarra
changed the title
|
|
||
| Next, make the data connection ID from step two (above) available to the SMB user by, for example, surfacing the ID in your application. They'll need to enter this ID when connecting a bank account to Sage, as described in the next procedure. | ||
|
|
||
| ## Surface the one-time password (OTP) to the user |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
|
|
||
| ## Surface the one-time password (OTP) to the user | ||
|
|
||
| In order to authenticate the connection, your user needs to enter a one-time password in their Sage product. Call the OTP endpoint to retrieve the OTP, then display it to the user in your application. |
There was a problem hiding this comment.
[Google.WordList] Use 'app' instead of 'application'.
Corrected spelling errors and improved clarity in the setup instructions for Sage bank feeds.
| 7. The SMB user selects the bank account they want to connect, then clicks **OK**. | ||
|
|
||
| 7. The SMB user is redirected to the Sage product from which they started the connection flow. | ||
| 8. The SMB user is redirected to the Sage product from which they started the connection flow. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is redirected').
|
Link check results for preview deployment (https://codat-docs-git-update-sage-docs-otp-flow-codat.vercel.app): |
2 participants
Description
Type of change
Please delete options that are not relevant.
Reviews and merging
You are responsible for getting your PR merged. Address review comments promptly and make sure to merge the PR when ready.
Feel free to 'Enable automerge' - your PR will automatically merge when accepted and passing the build.