README.md in yoti-1.4.0 vs README.md in yoti-1.5.0
- old
+ new
@@ -17,11 +17,11 @@
1. [Support](#support) - Please feel free to reach out
## An Architectural view
To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens.
-The endpoint is configured in the [Yoti Dashboard](https://www.yoti.com/dashboard) where you create/update your application. To see an example of how this is configured, see the [Running the Examples](#running-the-examples) section.
+The endpoint is configured in the [Yoti Hub](https://hub.yoti.com) where you create/update your application. To see an example of how this is configured, see the [Running the Examples](#running-the-examples) section.
The image below shows how your application back-end and Yoti integrate into the context of a Login flow.
Yoti SDK carries out for you steps 6, 7, 8 and the profile decryption in step 9.
@@ -96,11 +96,11 @@
end
```
Make sure the following environment variables can be accessed by your app:
-`YOTI_CLIENT_SDK_ID` - found on the Key settings page on your application dashboard
+`YOTI_CLIENT_SDK_ID` - found on the Key settings page on your Yoti Hub
`YOTI_KEY_FILE_PATH` - the full path to your security key downloaded from the *Keys* settings page (e.g. /Users/developer/access-security.pem)
The following options are available:
@@ -159,11 +159,11 @@
else
# handle unhappy path
end
```
-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.
+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.
### Handling Users
When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for your application.
This means that if the same individual logs into another app, Yoti will assign her/him a different ID.
@@ -192,29 +192,32 @@
Where `your_user_search_function` is a piece of logic in your app that is supposed to find a user, given a user_id. Regardless of whether the user is a new or an existing one, Yoti will always provide their profile, so you don't necessarily need to store it.
You can retrieve the sources and verifiers for each attribute as follows:
```ruby
-given_names_sources = profile.given_names.sources // list of anchors
-given_names_verifiers = profile.given_names.verifiers // list of anchors
+given_names_sources = profile.given_names.sources # list of anchors
+given_names_verifiers = profile.given_names.verifiers # list of anchors
+given_names_anchors = profile.given_names.anchors # list of anchors
```
You can also retrieve further properties from these respective anchors in the following way:
```ruby
-// Retrieving properties of the first anchor
-value = given_names_sources[0].value // string
-sub_type = given_names_sources[0].sub_type // string
-time_stamp = given_names_sources[0].signed_time_stamp.time_stamp // DateTime object
-origin_server_certs = given_names_sources[0].origin_server_certs // list of X509 certificates
+# Retrieving properties of the first anchor
+type = given_names_sources[0].type # string
+value = given_names_sources[0].value # string
+sub_type = given_names_sources[0].sub_type # string
+time_stamp = given_names_sources[0].signed_time_stamp.time_stamp # DateTime object
+origin_server_certs = given_names_sources[0].origin_server_certs # list of X509 certificates
```
In case you want to prove the sources and verifiers of the helper`ActivityDetails.age_verified` on `Age Over 18` set as age derivation, please retrieve it's original attribute from the profile as follow:
```ruby
age_attribute = profile.get_attribute('age_over:18')
sources = age_attribute.sources
verifiers = age_attribute.verifiers
+anchors = age_attribute.anchors
```
## AML Integration
Yoti provides an AML (Anti Money Laundering) check service to allow a deeper KYC process to prevent fraud. This is a chargeable service, so please contact [sdksupport@yoti.com](mailto:sdksupport@yoti.com) for more information.
@@ -223,15 +226,15 @@
* PEP list - Verify against Politically Exposed Persons list
* Fraud list - Verify against US Social Security Administration Fraud (SSN Fraud) list
* Watch list - Verify against watch lists from the Office of Foreign Assets Control
-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.
+To use this functionality you must ensure your application is assigned to your organisation in the Yoti Hub - please see [here](https://developers.yoti.com/yoti-app-integration/yoti-app-integration#step-1-creating-an-organisation) for further information.
For the AML check you will need to provide the following:
-* 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)
+* Data provided by Yoti (please ensure you have selected the Given name(s) and Family name attributes for your scenario on the Yoti Hub)
* Given name(s)
* Family name
* Data that must be collected from the user:
* Country of residence (must be an ISO 3166 3-letter code)
* Social Security Number (US citizens only)
@@ -264,11 +267,11 @@
The examples can be found in the [examples folder](examples).
### Ruby on Rails
-1. Create your application in the [Yoti Dashboard](https://www.yoti.com/dashboard/applications)
+1. Create your application in the [Yoti Hub](https://hub.yoti.com)
1. Set the application domain of your app to `localhost:3000`
1. Set the scenario callback URL to `/profile`
1. Rename the [.env.example](examples/rails/.env.example) file to `.env`
1. Fill in the environment variables in this file with the ones specific to your application (mentioned in the [Configuration](#configuration) section)
1. Install the dependencies by running the following commands
@@ -280,11 +283,11 @@
Visiting `https://localhost:3001/` should show a Yoti Connect button
### Sinatra
-1. Create your application in the [Yoti Dashboard](https://www.yoti.com/dashboard/applications)
+1. Create your application in the [Yoti Hub](https://hub.yoti.com)
1. Set the application domain of your app to `localhost:4567`
1. Set the scenario callback URL to `/profile`
1. Rename the [.env.example](examples/sinatra/.env.example) file to `.env`
1. Fill in the environment variables in this file with the ones specific to your application (mentioned in the [Configuration](#configuration) section)
1. Install the dependencies by running the following commands
@@ -305,10 +308,12 @@
## API Coverage
* Activity Details
* [X] Remember Me ID `remember_me_id`
* [X] Parent Remember Me ID `parent_remember_me_id`
+ * [X] Receipt ID `receipt_id`
+ * [X] Timestamp `timestamp`
* [X] Base64 Selfie URI `base64_selfie_uri`
* [X] Age verified `age_verified`
* [X] Profile `profile`
* [X] Selfie `selfie`
* [X] Full Name `full_name`
@@ -316,11 +321,17 @@
* [X] Family Name `family_name`
* [X] Mobile Number `phone_number`
* [X] Email Address `email_address`
* [X] Age / Date of Birth `date_of_birth`
* [X] Address `postal_address`
+ * [X] Structured Postal Address `structured_postal_address`
* [X] Gender `gender`
* [X] Nationality `nationality`
+ * [X] Application Profile `application_profile`
+ * [X] Name `name`
+ * [X] URL `url`
+ * [X] Logo `logo`
+ * [X] Receipt Background Color `receipt_bgcolor`
## Support
For any questions or support please email [sdksupport@yoti.com](mailto:sdksupport@yoti.com).
Please provide the following to get you up and working as quickly as possible: