Skip to content

Commit 400155c

Browse files
committed
SDK-1005: Rename Yoti Hub from Yoti Dashboard
Also updated URIs from *yoti.com/dashboard* to *yoti.com/hub*
1 parent 973417c commit 400155c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Please feel free to reach out
4343
## An Architectural View
4444

4545
Before you start your integration, here is a bit of background on how the integration works. To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens.
46-
The endpoint can be configured in the Yoti Dashboard when you create/update your application. For more information on how to create an application please check our [developer page](https://www.yoti.com/developers/documentation/#login-button-setup).
46+
The endpoint can be configured in the Yoti Hub when you create/update your application. For more information on how to create an application please check our [developer page](https://www.yoti.com/developers/documentation/#login-button-setup).
4747

4848
The image below shows how your application back-end and Yoti integrate into the context of a Login flow.
4949
Yoti SDK carries out for you steps 6, 7 and the profile decryption in step 8.
@@ -86,13 +86,13 @@ import yoti_python_sdk
8686

8787
## Configuration
8888

89-
After creating your application on the [Yoti Dashboard](https://www.yoti.com/dashboard/), you need to download the `.PEM` key and save it *outside* the repo (keep it private).
89+
After creating your application on the [Yoti Hub](https://www.yoti.com/hub/), you need to download the `.PEM` key and save it *outside* the repo (keep it private).
9090

91-
The variables required for the SDK to work are found in the tabs on your Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)). These are:
91+
The variables required for the SDK to work are found in the tabs on your Yoti application's settings page ([Yoti Hub](https://www.yoti.com/hub/)). These are:
9292

9393
* **`YOTI_SCENARIO_ID`** - This is used to configure the Yoti Login Button (see [Front End Integration](https://developers.yoti.com/yoti-app-integration/yoti-app-integration#step-3-front-end-integration)).
94-
* **`YOTI_CLIENT_SDK_ID`** - This is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code.
95-
* **`YOTI_KEY_FILE_PATH`** - This is the path to the application .pem file, we recommend keeping your .pem file outside of your repository. It can be downloaded only once from the Keys tab in your Yoti Dashboard. (e.g. /home/user/.ssh/access-security.pem).
94+
* **`YOTI_CLIENT_SDK_ID`** - This is the SDK identifier generated by Yoti Hub in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code.
95+
* **`YOTI_KEY_FILE_PATH`** - This is the path to the application .pem file, we recommend keeping your .pem file outside of your repository. It can be downloaded only once from the Keys tab in your Yoti Hub. (e.g. /home/user/.ssh/access-security.pem).
9696

9797
**Please do not open the pem file** as this might corrupt the key and you will need to create a new application.
9898

@@ -157,7 +157,7 @@ timestamp = source_anchor.signed_timestamp
157157
origin_server_certs = source_anchor.origin_server_certs
158158
```
159159

160-
If you have chosen `Verify Condition` on the [Yoti Dashboard](https://www.yoti.com/dashboard/applications) with the age condition of "Over 18", you can retrieve the user information as follows:
160+
If you have chosen `Verify Condition` on the [Yoti Hub](https://www.yoti.com/hub/applications) with the age condition of "Over 18", you can retrieve the user information as follows:
161161
```python
162162
age_verification_attribute = profile.get_attribute("age_over:18")
163163
```
@@ -173,11 +173,11 @@ Yoti will provide a boolean result on the following checks:
173173
* Fraud list - Verify against US Social Security Administration Fraud (SSN Fraud) list
174174
* Watch list - Verify against watch lists from the Office of Foreign Assets Control
175175

176-
To use this functionality you must ensure your application is assigned to your Organisation in the Yoti Dashboard - please see [here](https://www.yoti.com/developers/documentation/#1-creating-an-organisation) for further information.
176+
To use this functionality you must ensure your application is assigned to your Organisation in the Yoti Hub - please see [here](https://www.yoti.com/developers/documentation/#1-creating-an-organisation) for further information.
177177

178178
For the AML check you will need to provide the following:
179179

180-
* Data provided by Yoti (please ensure you have selected the Given name(s) and Family name attributes from the Data tab in the Yoti Dashboard)
180+
* Data provided by Yoti (please ensure you have selected the Given name(s) and Family name attributes from the Data tab in the Yoti Hub)
181181
* Given name(s)
182182
* Family name
183183
* Data that must be collected from the user:
@@ -222,7 +222,7 @@ Additionally an [example AML application](/examples/aml/app.py) is provided in t
222222

223223
## Running the Examples
224224

225-
From the [Yoti Dashboard](https://www.yoti.com/dashboard/applications):
225+
From the [Yoti Hub](https://www.yoti.com/hub/applications):
226226
1. Set the application domain of your app to `localhost:5000`
227227
1. Set the scenario callback URL to `/yoti/auth`
228228

0 commit comments

Comments
 (0)