Class: SmileIdentityCore::BusinessVerification

Inherits:
Object
  • Object
show all
Includes:
Validations
Defined in:
lib/smile-identity-core/business_verification.rb

Overview

The business verification product lets you search the business registration or tax information (available in Nigeria only) of a business from one of our supported countries. For more info visit docs.usesmileid.com/products/for-businesses-kyb/business-verification

Constant Summary collapse

BASIC_BUSINESS_REGISTRATION = 
'BASIC_BUSINESS_REGISTRATION'
BUSINESS_REGISTRATION = 
'BUSINESS_REGISTRATION'
TAX_INFORMATION = 
'TAX_INFORMATION'
REQUIRED_ID_INFO_FIELD = 
%i[country id_type id_number].freeze

Instance Method Summary collapse

Methods included from Validations

#validate_id_info, #validate_partner_params

Constructor Details

#initialize(partner_id, api_key, sid_server) ⇒ BusinessVerification

Submit business verification

Parameters:

  • :partner_id (String) —

    A unique number assigned by Smile ID to your account. Can be found in the portal

  • :api_key (String) —

    your API key from the Smile Identity portal

  • :sid_server (String) —

    Use 0 for the sandbox server, use 1 for production server



26
27
28
29
30
31
 
# File 'lib/smile-identity-core/business_verification.rb', line 26

def initialize(partner_id, api_key, sid_server)
  @api_key = api_key
  @partner_id = partner_id.to_s
  @sid_server = sid_server
  @url = SmileIdentityCore::ENV.determine_url(sid_server)
end

Instance Method Details

#submit_job(partner_params, id_info) ⇒ Object

Submit business verification bn - business name co - private/public limited it - incorporated trustees

Parameters:

  • partner_params (Hash) —

    the options to create a job with.

  • id_info (Hash)
  • opts (Hash) —

    a customizable set of options



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/smile-identity-core/business_verification.rb', line 44

def submit_job(partner_params, id_info)
  @partner_params = validate_partner_params(symbolize_keys(partner_params))
  @id_info = validate_id_info(symbolize_keys(id_info), REQUIRED_ID_INFO_FIELD)

  if @partner_params[:job_type].to_i != JobType::BUSINESS_VERIFICATION
    raise ArgumentError, 'Please ensure that you are setting your job_type to 7 to query Business Verification'
  end

  submit_requests
end