Class: Jumio::Repositories::Scan

Inherits:
Object
  • Object
show all
Defined in:
lib/jumio/repositories/scan.rb

Overview

A wrapper for the Netverify scan retreival API

github.com/Jumio/implementation-guides/blob/master/netverify/netverify-retrieval-api.md

Instance Method Summary collapse

Instance Method Details

#get_details(scan_reference, client = nil) ⇒ Entities::Scan

Parameters:

  • scan_reference (String) —

    Jumio’s reference number of an existing scan from your account

  • client (Jumio::HttpClient, nil) (defaults to: nil) —

    The HTTP client to use

Returns:



24
25
26
27
 
# File 'lib/jumio/repositories/scan.rb', line 24

def get_details(scan_reference, client = nil)
  raw_scan = (client || default_client.new).get("netverify/v2/scans/#{scan_reference}/data")
  Entities::Scan.new(raw_scan)
end

#get_status(scan_reference, client = nil) ⇒ Entities::ScanStatus

Parameters:

  • scan_reference (String) —

    Jumio’s reference number of an existing scan from your account

  • client (Jumio::HttpClient, nil) (defaults to: nil) —

    The HTTP client to use

Returns:



16
17
18
19
 
# File 'lib/jumio/repositories/scan.rb', line 16

def get_status(scan_reference, client = nil)
  raw_scan_status = (client || default_client.new).get("netverify/v2/scans/#{scan_reference}")
  Entities::ScanStatus.new(raw_scan_status)
end