You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ Please feel free to reach out
40
40
## An Architectural View
41
41
42
42
To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens.
43
-
The endpoint can be configured in Yoti Dashboard when you create/update your application.
43
+
The endpoint can be configured in Yoti Hub when you create/update your application.
44
44
45
45
The image below shows how your application back-end and Yoti integrate in the context of a Login flow.
46
46
Yoti SDK carries out steps 6 through 9 for you, including profile decryption and communication with backend services.
@@ -88,8 +88,8 @@ try {
88
88
89
89
Where:
90
90
91
-
*`YOUR_SDK_ID` is the identifier generated by Yoti Dashboard when you create your app.
92
-
*`PATH/TO/YOUR/APPLICATION/KEY_PAIR.pem` is the path to the pem file your browser generates for you, when you create your app on Yoti Dashboard.
91
+
*`YOUR_SDK_ID` is the identifier generated by Yoti Hub when you create your app.
92
+
*`PATH/TO/YOUR/APPLICATION/KEY_PAIR.pem` is the path to the pem file your browser generates for you, when you create your app on Yoti Hub.
93
93
94
94
## Profile Retrieval
95
95
@@ -177,7 +177,7 @@ try {
177
177
Where `yourUserSearchMethod` is a piece of logic in your app that is supposed to find a user, given a userId.
178
178
No matter if the user is a new or an existing one, Yoti will always provide her/his profile, so you don't necessarily need to store it.
179
179
180
-
The `profile` object provides a set of attributes corresponding to user attributes. Whether the attributes are present or not depends on the settings you have applied to your app on Yoti Dashboard.
180
+
The `profile` object provides a set of attributes corresponding to user attributes. Whether the attributes are present or not depends on the settings you have applied to your app on Yoti Hub.
181
181
182
182
You can retrieve the sources and verifiers for each attribute as follows:
183
183
@@ -212,7 +212,7 @@ Yoti will provide a boolean result on the following checks:
212
212
* Watch list - Verify against watch lists from the Office of Foreign Assets Control
213
213
214
214
To use this functionality you must ensure:
215
-
* Your application is assigned to your Organisation in the Yoti Dashboard - please see [here]('https://www.yoti.com/developers/documentation') for further information.
215
+
* Your application is assigned to your Organisation in the Yoti Hub - please see [here]('https://www.yoti.com/developers/documentation') for further information.
216
216
* Within your application please ensure that you have selected the 'given names' and 'family name' attributes from the data tab. This is the minimum requirement for the AML check.
217
217
218
218
The AML check uses a simplified view of the User Profile. You need only provide the following:
@@ -262,7 +262,7 @@ Please note all our examples work with [Docker](https://docs.docker.com/).
262
262
263
263
### Profile sharing
264
264
265
-
* Create your application in the [Yoti Dashboard](https://www.yoti.com/dashboard/applications) (this requires having a Yoti account)
265
+
* Create your application in the [Yoti Hub](https://hub.yoti.com) (this requires having a Yoti account)
266
266
* Set the application domain of your app to `localhost:4002`
267
267
* Set the scenario callback URL to `/profile.php`
268
268
* Do the steps below inside the [examples folder](https://github.com/getyoti/php/tree/master/examples)
@@ -275,7 +275,7 @@ Please note all our examples work with [Docker](https://docs.docker.com/).
275
275
276
276
### AML Check
277
277
278
-
* Create your application in the [Yoti Dashboard](https://www.yoti.com/dashboard/applications) (this requires having a Yoti account)
278
+
* Create your application in the [Yoti Hub](https://hub.yoti.com) (this requires having a Yoti account)
279
279
* Do the steps below inside the [examples folder](https://github.com/getyoti/php/tree/master/examples)
280
280
* Put `your-application-pem-file.pem` file inside the [examples/keys](https://github.com/getyoti/php/tree/master/examples/keys) folder. As Docker requires the `.pem` file to reside within the same location where it's run from.
281
281
* Copy `.env.dist` to `.env` and fill in the environment variables `YOTI_APPLICATION_ID`, `YOTI_SCENARIO_ID`, `YOTI_SDK_ID`
@@ -324,7 +324,7 @@ $ ./vendor/bin/phpunit tests
324
324
*[X] Age / Date of Birth `getDateOfBirth()->getValue()` // DateTime Object
325
325
*[X] Date `format('d-m-Y')`
326
326
*[X] Age / Age Verifications `getAgeVerifications()` // array of AgeVerification Object
327
-
*[X] Age Over 50 `['age_over:50']` // AgeVerification Object, this depends on your settings on Yoti Dashboard
327
+
*[X] Age Over 50 `['age_over:50']` // AgeVerification Object, this depends on your settings on Yoti Hub
328
328
*[X] Age Under Verification `findAgeUnderVerification($xx)` // Yoti\Entity\AgeVerification Object
329
329
*[X] Age Over Verification `findAgeOverVerification($xx)` // Yoti\Entity\AgeVerification Object, see details below
0 commit comments