This repository was archived by the owner on May 16, 2025. It is now read-only.
Releases: getyoti/yoti-ruby-sdk
Releases · getyoti/yoti-ruby-sdk
Release list
v1.10.0
Doc Scan
Added
- Support for supplementary documents
- Document page frames support
Deprecated
Yoti::DocScan::Session::Retrieve::GetSessionResult#text_data_checksreplaced byid_document_text_data_checks
Fixed
204media responses now returnnil
v1.9.0
Added
Doc Scan
- Support for ID document comparison checks
- Ability to block the collection of bio-metric consent
- Allow the configuration of the
manual_checkvalue for requested Document Authenticity checks
v1.8.0
Added
- Doc Scan chip data support
RequestedTextExtractionTaskBuilder#with_chip_data_desiredRequestedTextExtractionTaskBuilder#with_chip_data_ignoreIdDocumentResourceResponse#document_id_photo
- Dynamic Scenarios
- Support for document images
- Source constraint support for document details
- Allow
accept_self_assertedoption when requesting attributes in a dynamic policy
Changed
Yoti::DocScan::Clientcalls now raisesYoti::DocScan::Error < RequestErrorwith formatted error response (wasRequestErrorwith JSON response)Note:
rescue Yoti::RequestErrorwill continue to work as beforeExample
PAYLOAD_VALIDATION - There were errors validating the payload: sdk_config.allowed_capture_methods "Value is not valid", sdk_config.font_colour "provided colour must be a valid Hex Code", sdk_config.locale "must not be blank"
Fixed
Yoti::SignedTimeStamp#time_stampis now UTC - the underlying timestamp remains unchanged
v1.7.1
Fixed
- Requiring
cgito allow standalone use ofYoti::Request
v1.7.0
Added
Yoti::DocScan::Client.create_session.get_session.delete_session.get_media_content.delete_media_content.supported_documentsreturns list of supported documents for each country
- Default API URLs can now be overridden using environment variables:
YOTI_API_URLto override the default API URLYOTI_DOC_SCAN_API_URLto override the default Doc Scan API URL
Yoti::RequestBuilder- builder forYoti::Request
Deprecated
Yoti::Request#encrypted_connect_tokentoken is now provided with the endpointappIdquery param is now only added byYoti::Requestwhenquery_paramsarenilYoti::DynamicSharingService::Share.create_share_url_queryno longer in useYoti::DynamicSharingService::Share.create_share_url_endpointno longer in use
v1.6.4
Fixed
- 3rd Party Attribute Expiry Date Format is now UTC RFC-3339 with milliseconds
- No longer using
Array#append- affects Ruby2.4without Active Support
Removed
- Removed unused
protobufdependency - Removed unused
activesupportdependency
Added
- Test compatibility with Ruby
2.7
v1.6.3
Fixed
- Requiring
timeforTime.parsein activity details
Removed
- Sandbox Client is removed - now available at https://github.com/getyoti/yoti-ruby-sdk-sandbox
v1.6.2
Fixed
- Document details parsing: now accommodates more values (including redacted Aadhar numbers)
v1.6.1
Fixed
- JSON payload for thirdparty extension to match api specification
v1.6.0
Added
- Document Details, available through
Yoti::Profile#document_details - Access to lists of age verifications through
Yoti::Profile#age_verifications,Yoti::Profile#find_age_over_verification(age)andYoti::Profile#find_age_under_verification(age) - Dynamic Share support through
Yoti::DynamicSharingServiceDynamicScenarioto create a specification for a dynamic shareDynamicPolicyto create a specification for wanted attributes and authorisation typesWantedAttributeto create a specification for an individual attributecreate_share_urlto request a share QR for a Dynamic ScenarioSourceConstraintto restrict anchors used to satisfy a dynamic shareWantedAnchorto define the specification for an anchor
- Third Party Attribute support
extra_datatoActivityDetailsThirdpartyAttributeExtensionto issue third party attributes when Yoti Hub is set up with support
Changed
SignedRequestno longer sets usecase specific headers (such as X-Yoti-Auth-Key and 'Content-Type') and only sets SDK Name and Version, unless used through the Yoti Client
Deprecated
Yoti::ActivityDetails#age_verifiedYoti::AgeProcessor