smile-identity-core 1.2.1 → 2.0.0

data/README.md

@@ -1,27 +1,32 @@
-# SmileIdentityCore [![Build Status](https://travis-ci.com/smileidentity/smile-identity-core-ruby.svg?branch=master)](https://travis-ci.com/smileidentity/smile-identity-core-ruby)
+# Smile Identity Ruby Server Side SDK
 
-The official Smile Identity gem exposes four classes namely; the Web Api class, the ID Api class, the Signature class and the Utilities class.
+Smile Identity provides the best solutions for real time Digital KYC, identity verification, user onboarding, and user authentication across Africa. Our server side libraries make it easy to integrate us on the server-side. Since the library is server-side, you will be required to pass the images (if required) to the library.
 
-The **Web Api Class** allows you as the Partner to validate a user’s identity against the relevant Identity Authorities/Third Party databases that Smile Identity has access to using ID information provided by your customer/user (including photo for compare). It has the following public methods:
-- submit_job
-- get_job_status
-- get_web_token
+If you haven’t already, [sign up for a free Smile Identity account](https://www.smileidentity.com/schedule-a-demo/), which comes with Sandbox access.
 
-The **ID Api Class** lets you performs basic KYC Services including verifying an ID number as well as retrieve a user's Personal Information. It has the following public methods:
-- submit_job
+Please see [CHANGELOG.md](CHANGELOG.md) for release versions and changes.
 
-The **Signature Class** allows you as the Partner to generate a sec key to interact with our servers. It has the following public methods:
-- generate_sec_key
-- confirm_sec_key
+## Features
 
-The **Utilities Class** allows you as the Partner to have access to our general Utility functions to gain access to your data. It has the following public methods:
-- get_job_status
+The library exposes four classes namely; the WebApi class, the IDApi class, the Signature class, and the Utilities class.
 
-## Documentation
+The WebApi class has the following public methods:
+
+- `submit_job` - handles submission of any of Smile Identity products that requires an image i.e. [Biometric KYC](https://docs.smileidentity.com/products/biometric-kyc), [Document Verification](https://docs.smileidentity.com/products/document-verification), [SmartSelfieTM Authentication](https://docs.smileidentity.com/products/biometric-authentication) and [Business Verification](https://docs.smileidentity.com/products/for-businesses-kyb/business-verification).
+- `get_web_token` - handles generation of web token, if you are using the [Hosted Web Integration](https://docs.smileidentity.com/web-mobile-web/web-integration-beta).
+
+The IDApi class has the following public method:
+
+- `submit_job` - handles submission of [Enhanced KYC](https://docs.smileidentity.com/products/identity-lookup) and [Basic KYC](https://docs.smileidentity.com/products/id-verification).
+
+The Signature class has the following public methods:
+
+- `generate_signature` - generate a signature which is then passed as a signature param when making requests to the Smile Identity server.
+- `confirm_signature` - ensure a response is truly from the Smile Identity server by confirming the incoming signature.
 
-This gem requires specific input parameters, for more detail on these parameters please refer to our [documentation for Web API](https://docs.smileidentity.com).
+The Utilities Class allows you as the Partner to have access to our general Utility functions to gain access to your data. It has the following public methods:
 
-Please note that you will have to be a Smile Identity Partner to be able to query our services. You can sign up on the [Portal](https://portal.smileidentity.com/signup).
+- `get_job_status` - retrieve information & results of a job. Read more on job status in the [Smile Identity documentation](https://docs.smileidentity.com/further-reading/job-status).
 
 ## Installation
 
@@ -32,6 +37,7 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'smile-identity-core'
 ```
+
 and require the package:
 
 ```ruby
@@ -40,461 +46,24 @@ require 'smile-identity-core'
 
 Or install it to your system as:
 
-```sh
-  $ gem install smile-identity-core
-```
-
-You now may use the classes as follows:
-
-#### Web Api Class
-
-##### submit_job method
-```ruby
-connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
-
-response = connection.submit_job(partner_params, images, id_info, options)
-```
-
-Please note that if you do not need to pass through id_info or options, you may omit calling those class and send through nil in submit_job, as follows:
-
-```ruby
-response = connection.submit_job(partner_params, images, nil, nil);
-```
-
-In the case of a Job Type 5 you can simply omit the the images and options keys. Remember that the response is immediate, so there is no need to query the job_status. There is also no enrollment so no images are required. The response for a job type 5 can be found in the response section below.
-
-```ruby
-response = connection.submit_job(partner_params, nil, id_info, nil);
-```
-
-**Response:**
-
-Should you choose to *set return_job_status to false*, the response will be a JSON String containing:
-```ruby
-{success: true, smile_job_id: smile_job_id}
-```
-
-However, if you have *set return_job_status to true (with image_links and history)* then you will receive JSON Object response like below:
-```json
-{
-   "job_success":true,
-   "result":{
-      "ConfidenceValue":"99",
-      "JSONVersion":"1.0.0",
-      "Actions":{
-         "Verify_ID_Number":"Verified",
-         "Return_Personal_Info":"Returned",
-         "Human_Review_Update_Selfie":"Not Applicable",
-         "Human_Review_Compare":"Not Applicable",
-         "Update_Registered_Selfie_On_File":"Not Applicable",
-         "Liveness_Check":"Not Applicable",
-         "Register_Selfie":"Approved",
-         "Human_Review_Liveness_Check":"Not Applicable",
-         "Selfie_To_ID_Authority_Compare":"Completed",
-         "Selfie_To_ID_Card_Compare":"Not Applicable",
-         "Selfie_To_Registered_Selfie_Compare":"Not Applicable"
-      },
-      "ResultText":"Enroll User",
-      "IsFinalResult":"true",
-      "IsMachineResult":"true",
-      "ResultType":"SAIA",
-      "PartnerParams":{
-         "job_type":"1",
-         "optional_info":"we are one",
-         "user_id":"HBBBBBBH57g",
-         "job_id":"HBBBBBBHg"
-      },
-      "Source":"WebAPI",
-      "ResultCode":"0810",
-      "SmileJobID":"0000001111"
-   },
-   "code":"2302",
-   "job_complete":true,
-   "signature":"HKBhxcv+1qaLy\C7PjVtk257dE=|1577b051a4313ed5e3e4d29893a66f966e31af0a2d2f6bec2a7f2e00f2701259",
-   "history":[
-      {
-         "ConfidenceValue":"99",
-         "JSONVersion":"1.0.0",
-         "Actions":{
-            "Verify_ID_Number":"Verified",
-            "Return_Personal_Info":"Returned",
-            "Human_Review_Update_Selfie":"Not Applicable",
-            "Human_Review_Compare":"Not Applicable",
-            "Update_Registered_Selfie_On_File":"Not Applicable",
-            "Liveness_Check":"Not Applicable",
-            "Register_Selfie":"Approved",
-            "Human_Review_Liveness_Check":"Not Applicable",
-            "Selfie_To_ID_Authority_Compare":"Completed",
-            "Selfie_To_ID_Card_Compare":"Not Applicable",
-            "Selfie_To_Registered_Selfie_Compare":"Not Applicable"
-         },
-         "ResultText":"Enroll User",
-         "IsFinalResult":"true",
-         "IsMachineResult":"true",
-         "ResultType":"SAIA",
-         "PartnerParams":{
-            "job_type":"1",
-            "optional_info":"we are one",
-            "user_id":"HBBBBBBH57g",
-            "job_id":"HBBBBBBHg"
-         },
-         "Source":"WebAPI",
-         "ResultCode":"0810",
-         "SmileJobID":"0000001111"
-      }
-   ],
-   "image_links":{
-      "selfie_image":"image_link"
-   },
-   "timestamp":"2019-10-10T12:32:04.622Z"
-}
-```
-
-You can also *view your response asynchronously at the callback* that you have set, it will look as follows:
-```json
-{
-   "job_success":true,
-   "result":{
-      "ConfidenceValue":"99",
-      "JSONVersion":"1.0.0",
-      "Actions":{
-         "Verify_ID_Number":"Verified",
-         "Return_Personal_Info":"Returned",
-         "Human_Review_Update_Selfie":"Not Applicable",
-         "Human_Review_Compare":"Not Applicable",
-         "Update_Registered_Selfie_On_File":"Not Applicable",
-         "Liveness_Check":"Not Applicable",
-         "Register_Selfie":"Approved",
-         "Human_Review_Liveness_Check":"Not Applicable",
-         "Selfie_To_ID_Authority_Compare":"Completed",
-         "Selfie_To_ID_Card_Compare":"Not Applicable",
-         "Selfie_To_Registered_Selfie_Compare":"Not Applicable"
-      },
-      "ResultText":"Enroll User",
-      "IsFinalResult":"true",
-      "IsMachineResult":"true",
-      "ResultType":"SAIA",
-      "PartnerParams":{
-         "job_type":"1",
-         "optional_info":"we are one",
-         "user_id":"HBBBBBBH57g",
-         "job_id":"HBBBBBBHg"
-      },
-      "Source":"WebAPI",
-      "ResultCode":"0810",
-      "SmileJobID":"0000001111"
-   },
-   "code":"2302",
-   "job_complete":true,
-   "signature":"HKBhxcv+1qaLy\C7PjVtk257dE=|1577b051a4313ed5e3e4d29893a66f966e31af0a2d2f6bec2a7f2e00f2701259",
-   "history":[
-      {
-         "ConfidenceValue":"99",
-         "JSONVersion":"1.0.0",
-         "Actions":{
-            "Verify_ID_Number":"Verified",
-            "Return_Personal_Info":"Returned",
-            "Human_Review_Update_Selfie":"Not Applicable",
-            "Human_Review_Compare":"Not Applicable",
-            "Update_Registered_Selfie_On_File":"Not Applicable",
-            "Liveness_Check":"Not Applicable",
-            "Register_Selfie":"Approved",
-            "Human_Review_Liveness_Check":"Not Applicable",
-            "Selfie_To_ID_Authority_Compare":"Completed",
-            "Selfie_To_ID_Card_Compare":"Not Applicable",
-            "Selfie_To_Registered_Selfie_Compare":"Not Applicable"
-         },
-         "ResultText":"Enroll User",
-         "IsFinalResult":"true",
-         "IsMachineResult":"true",
-         "ResultType":"SAIA",
-         "PartnerParams":{
-            "job_type":"1",
-            "optional_info":"we are one",
-            "user_id":"HBBBBBBH57g",
-            "job_id":"HBBBBBBHg"
-         },
-         "Source":"WebAPI",
-         "ResultCode":"0810",
-         "SmileJobID":"0000001111"
-      }
-   ],
-   "image_links":{
-      "selfie_image":"image_link"
-   },
-   "timestamp":"2019-10-10T12:32:04.622Z"
-}
-```
-
-If you have queried a job type 5, your response be a JSON String that will contain the following:
-```json
-{
-   "JSONVersion":"1.0.0",
-   "SmileJobID":"0000001105",
-   "PartnerParams":{
-      "user_id":"T6yzdOezucdsPrY0QG9LYNDGOrC",
-      "job_id":"FS1kd1dd15JUpd87gTBDapvFxv0",
-      "job_type":5
-   },
-   "ResultType":"ID Verification",
-   "ResultText":"ID Number Validated",
-   "ResultCode":"1012",
-   "IsFinalResult":"true",
-   "Actions":{
-      "Verify_ID_Number":"Verified",
-      "Return_Personal_Info":"Returned"
-   },
-   "Country":"NG",
-   "IDType":"PASSPORT",
-   "IDNumber":"A04150107",
-   "ExpirationDate":"2017-10-28",
-   "FullName":"ADEYEMI KEHINDE ADUNOLA",
-   "DOB":"1989-09-20",
-   "Photo":"SomeBase64Image",
-   "sec_key":"pjxsxEY69zEHjSPFvPEQTqu17vpZbw+zTNqaFxRWpYDiO+7wzKc9zvPU2lRGiKg7rff6nGPBvQ6rA7/wYkcLrlD2SuR2Q8hOcDFgni3PJHutij7j6ThRdpTwJRO2GjLXN5HHDB52NjAvKPyclSDANHrG1qb/tloO7x4bFJ7tKYE=|8faebe00b317654548f8b739dc631431b67d2d4e6ab65c6d53539aaad1600ac7",
-   "timestamp":1570698930193
-}
-```
-
-##### get_job_status method
-Sometimes, you may want to get a particular job status at a later time. You may use the get_job_status function to do this:
-
-You will already have your Web Api class initialised as follows:
-```ruby
-  connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
-```
-
-Thereafter, simply call get_job_status with the correct parameters:
-```ruby
-  response = connection.get_job_status(partner_params, options)
-
-  where options is {return_history: true | false, return_image_links: true | false}
-```
-
-Please note that if you do not need to pass through options if you will not be using them, you may omit pass through an empty hash or nil instead:
-```ruby
-response = connection.get_job_status(partner_params, nil);
-```
-
-**Response**
-
-Your response will return a JSON Object below with image_links and history included:
-
-```json
-{
-   "job_success":true,
-   "result":{
-      "ConfidenceValue":"99",
-      "JSONVersion":"1.0.0",
-      "Actions":{
-         "Verify_ID_Number":"Verified",
-         "Return_Personal_Info":"Returned",
-         "Human_Review_Update_Selfie":"Not Applicable",
-         "Human_Review_Compare":"Not Applicable",
-         "Update_Registered_Selfie_On_File":"Not Applicable",
-         "Liveness_Check":"Not Applicable",
-         "Register_Selfie":"Approved",
-         "Human_Review_Liveness_Check":"Not Applicable",
-         "Selfie_To_ID_Authority_Compare":"Completed",
-         "Selfie_To_ID_Card_Compare":"Not Applicable",
-         "Selfie_To_Registered_Selfie_Compare":"Not Applicable"
-      },
-      "ResultText":"Enroll User",
-      "IsFinalResult":"true",
-      "IsMachineResult":"true",
-      "ResultType":"SAIA",
-      "PartnerParams":{
-         "job_type":"1",
-         "optional_info":"we are one",
-         "user_id":"HBBBBBBH57g",
-         "job_id":"HBBBBBBHg"
-      },
-      "Source":"WebAPI",
-      "ResultCode":"0810",
-      "SmileJobID":"0000001111"
-   },
-   "code":"2302",
-   "job_complete":true,
-   "signature":"HKBhxcv+1qaLy\C7PjVtk257dE=|1577b051a4313ed5e3e4d29893a66f966e31af0a2d2f6bec2a7f2e00f2701259",
-   "history":[
-      {
-         "ConfidenceValue":"99",
-         "JSONVersion":"1.0.0",
-         "Actions":{
-            "Verify_ID_Number":"Verified",
-            "Return_Personal_Info":"Returned",
-            "Human_Review_Update_Selfie":"Not Applicable",
-            "Human_Review_Compare":"Not Applicable",
-            "Update_Registered_Selfie_On_File":"Not Applicable",
-            "Liveness_Check":"Not Applicable",
-            "Register_Selfie":"Approved",
-            "Human_Review_Liveness_Check":"Not Applicable",
-            "Selfie_To_ID_Authority_Compare":"Completed",
-            "Selfie_To_ID_Card_Compare":"Not Applicable",
-            "Selfie_To_Registered_Selfie_Compare":"Not Applicable"
-         },
-         "ResultText":"Enroll User",
-         "IsFinalResult":"true",
-         "IsMachineResult":"true",
-         "ResultType":"SAIA",
-         "PartnerParams":{
-            "job_type":"1",
-            "optional_info":"we are one",
-            "user_id":"HBBBBBBH57g",
-            "job_id":"HBBBBBBHg"
-         },
-         "Source":"WebAPI",
-         "ResultCode":"0810",
-         "SmileJobID":"0000001111"
-      }
-   ],
-   "image_links":{
-      "selfie_image":"image_link"
-   },
-   "timestamp":"2019-10-10T12:32:04.622Z"
-}
+```shell
+gem install smile-identity-core
 ```
 
-##### get_web_token method
- You may want to use our hosted web integration, and create a session. The `get_web_token` method enables this.
- You have your Web Api class initialised as follows:
- ```ruby
- connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
-
- ```
-
- Next, you'll need to create your request params. This should take the following
- structure:
-
- ```ruby
- {
- 	user_id: 'user-1', # String: required
- 	job_id: 'job-1', # String: required
- 	product: 'authentication', # String: required one of 'authentication', 'identity_verification', 'smartselfie', 'ekyc_smartselfie', 'enhanced_kyc', 'document_verification'
- 	callback_url: "https://smileidentity.com/callback" # String: required, optional if callback url was set during instantiation of the class
- }
- ```
-
- Thereafter, call `get_web_token` with the correct parameters:
- ```ruby
-   response = connection.get_web_token(request_params)
- ```
-
- **Response**
-
- Your response will return a hash that contains
- ```ruby
- {
- 	token: <token_string>
- }
- ```
-
-#### ID Api Class
-
-
-##### submit_job method
-```ruby
-connection = SmileIdentityCore::IDApi.new(partner_id, api_key, sid_server)
-
-response = connection.submit_job(partner_params, id_info)
-```
-
-**Response**
-
-Your response will return a JSON String containing the below:
-```json
-{
-   "JSONVersion":"1.0.0",
-   "SmileJobID":"0000001105",
-   "PartnerParams":{
-      "user_id":"T6yzdOezucdsPrY0QG9LYNDGOrC",
-      "job_id":"FS1kd1dd15JUpd87gTBDapvFxv0",
-      "job_type":5
-   },
-   "ResultType":"ID Verification",
-   "ResultText":"ID Number Validated",
-   "ResultCode":"1012",
-   "IsFinalResult":"true",
-   "Actions":{
-      "Verify_ID_Number":"Verified",
-      "Return_Personal_Info":"Returned"
-   },
-   "Country":"NG",
-   "IDType":"PASSPORT",
-   "IDNumber":"A04150107",
-   "ExpirationDate":"2017-10-28",
-   "FullName":"ADEYEMI KEHINDE ADUNOLA",
-   "DOB":"1989-09-20",
-   "Photo":"SomeBase64Image",
-   "sec_key":"pjxsxEY69zEHjSPFvPEQTqu17vpZbw+zTNqaFxRWpYDiO+7wzKc9zvPU2lRGiKg7rff6nGPBvQ6rA7/wYkcLrlD2SuR2Q8hOcDFgni3PJHutij7j6ThRdpTwJRO2GjLXN5HHDB52NjAvKPyclSDANHrG1qb/tloO7x4bFJ7tKYE=|8faebe00b317654548f8b739dc631431b67d2d4e6ab65c6d53539aaad1600ac7",
-   "timestamp":1570698930193
-}
-```
-
-#### Signature Class
-
-##### generate_sec_key method
-
-```ruby
-connection = SmileIdentityCore::Signature.new(partner_id, api_key)
-
-sec_key = connection.generate_sec_key(timestamp)
-where timestamp is optional
-
-```
-
-The response will be a hash:
-
-```ruby
-{
-  :sec_key=> "<the generated sec key>",
- :timestamp=> 1563283420
-}
-```
-
-##### confirm_sec_key method
-
-You can also confirm the signature that you receive when you interacting with our servers, simply use the confirm_sec_key method which returns a boolean:
-
-```ruby
-connection = SmileIdentityCore::Signature.new(partner_id, api_key)
-sec_key = connection.confirm_sec_key(sec_key, timestamp)
-```
-
-#### Utilities Class
-
-You may want to receive more information about a job. This is built into Web Api if you choose to set return_job_status as true in the options hash. However, you also have the option to build the functionality yourself by using the Utilities class. Please note that if you are querying a job immediately after submitting it, you will need to poll it for the duration of the job.
-
-```ruby
-utilities_connection = SmileIdentityCore::Utilities.new('partner_id', 'api_key' , sid_server)
-
-utilities_connection.get_job_status('user_id', 'job_id', options)
-where options is {return_history: true | false, return_image_links: true | false}
-```
-
-## Development
-
-After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`.
-
-You can use `bundle console` and then call the necessary classes with their parameters.
+## Documentation
 
-## Testing
+For extensive instructions on usage of the library and sample codes, please refer to the official Smile Identity [documentation](https://docs.smileidentity.com/server-to-server/ruby).
 
-Run `bundle exec rspec` to run the tests.
-After running your tests open the coverage/index.html to view the test coverage
+Before that, you should take a look at the examples in the [examples](/examples) folder.
 
-## Deployment
+## Getting Help
 
-To release a new version:
-- Update the version number in `version.rb`
-- Run `gem build smile-identity-core.gemspec`
-- Thereafter `gem push smile-identity-core-<version>.gem`.
+For usage questions, the best resource is [our official documentation](https://docs.smileidentity.com). However, if you require further assistance, you can file a [support ticket via our portal](https://portal.smileidentity.com/partner/support/tickets) or visit the [contact us page](https://portal.smileidentity.com/partner/support/tickets) on our website.
 
-Make sure to git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub [here](https://github.com/smileidentity/smile-identity-core-ruby).
 
-## Contributing
+## License
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/smileidentity/smile-identity-core
+MIT License

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "smile-identity-core"
+require 'bundler/setup'
+require 'smile-identity-core'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "smile-identity-core"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/examples/biometric_kyc.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+
+# See https://docs.smileidentity.com/server-to-server/ruby/products/biometric-kyc for
+# how to setup and retrieve configuation values for the WebApi class.
+
+# Initialize
+partner_id = '<Put your partner ID here>'; # login to the Smile Identity portal to view your partner id
+default_callback = '<Put your default callback url here>'
+api_key = '<Put your API key here>'; # copy your API key from the Smile Identity portal
+sid_server = '<0 | 1>'; # Use '0' for the sandbox server, use '1' for production server
+
+connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+
+# Create required tracking parameters
+partner_params = {
+  user_id: '<put your unique ID for the user here>',
+  job_id: '<put your unique job ID here>',
+  job_type: 1
+}
+
+# Create image list
+# image_type_id Integer
+# 0 - Selfie image jpg or png (if you have the full path of the selfie)
+# 2 - Selfie image jpg or png base64 encoded (if you have the base64image string of the selfie)
+# 4 - Liveness image jpg or png (if you have the full path of the liveness image)
+# 6 - Liveness image jpg or png base64 encoded (if you have the base64image string of the liveness image)
+image_details = [
+  {
+    image_type_id: '<0 | 2>',
+    image: '<full path to selfie image or base64image string>'
+  },
+  { # Not required if you don't require proof of life (note photo of
+    # photo check will still be performed on the uploaded selfie)
+    image_type_id: '<4 | 6>',
+    image: '<full path to liveness image or base64 image string>'
+  }
+]
+
+# Create ID number info
+id_info = {
+  first_name: '<first name>',
+  last_name: '<surname>',
+  country: '<2-letter country code>',
+  id_type: '<id type>',
+  id_number: '<valid id number>',
+  dob: '<date of birth>', # yyyy-mm-dd
+  entered: 'true' # must be a string
+}
+
+# Set options for the job
+options = {
+  # Set to true if you want to get the job result in sync (in addition to the result been sent
+  # to your callback). If set to false, result is sent to callback url only.
+  return_job_status: '<true | false>',
+  # Set to true to receive all of the updates you would otherwise have received in your callback
+  # as opposed to only the final result. You must set return_job_status to true to use this flag.
+  return_history: '<true | false>',
+  # Set to true to receive links to the selfie and the photo
+  # it was compared to. You must set return_job_status to true to use this flag.
+  return_image_links: '<true | false>',
+  signature: true
+}
+
+# Submit the job
+connection.submit_job(partner_params, image_details, id_info, options)

data/examples/business_verification.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+require 'securerandom'
+# See https://docs.smileidentity.com/products/for-businesses-kyb/business-verification for
+# more information on business verification
+
+# Initialize
+partner_id = '<Put your partner ID here>'; # login to the Smile Identity portal to view your partner id
+default_callback = '<Put your default callback url here>'
+api_key = '<Put your API key here>'; # copy your API key from the Smile Identity portal
+sid_server = '<0 | 1>'; # Use '0' for the sandbox server, use '1' for production server
+
+connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+
+# Create required tracking parameters
+partner_params = {
+  job_id: "job-#{SecureRandom.uuid}",
+  user_id: "user-#{SecureRandom.uuid}",
+  job_type: SmileIdentityCore::JobType::BUSINESS_VERIFICATION
+}
+
+# Create ID info
+id_info = {
+  # The country where ID document was issued
+  country: '<2-letter country code>',
+  # The ID document type
+  id_type: '<id type>',
+  # The business registration or tax number
+  id_number: '<id number>',
+  # The business incorporation type bn - business name, co - private/public limited, it - incorporated trustees
+  # Only required for BASIC_BUSINESS_REGISTRATION and BUSINESS_REGISTRATION in Nigeria
+  business_type: '<co | bn | it>'
+}
+
+# Submit the job
+connection.submit_job(partner_params, [], id_info, {})