Class: CheckoutSdk::Identities::IdentityVerification::IdentityVerificationClient

Inherits:
Client
  • Object
show all
Defined in:
lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb

Overview

Client for the Identities — Identity Verification API.

Instance Attribute Summary

Attributes inherited from Client

#api_client, #authorization_type, #configuration

Instance Method Summary collapse

Constructor Details

#initialize(api_client, configuration) ⇒ IdentityVerificationClient

Returns a new instance of IdentityVerificationClient.

Parameters:



18
19
20
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 18

def initialize(api_client, configuration)
  super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
end

Instance Method Details

#anonymize_identity_verification(identity_verification_id) ⇒ Object

Parameters:

  • identity_verification_id (String) 


40
41
42
43
44
45
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 40

def anonymize_identity_verification(identity_verification_id)
  api_client.invoke_post(
    build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ANONYMIZE),
    sdk_authorization
  )
end

#create_and_open_idv(request) ⇒ Object

Create an identity verification and immediately receive its hosted URL.

Parameters:



24
25
26
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 24

def create_and_open_idv(request)
  api_client.invoke_post(CREATE_AND_OPEN_IDV, sdk_authorization, request)
end

#create_identity_verification(request) ⇒ Object

Parameters:



29
30
31
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 29

def create_identity_verification(request)
  api_client.invoke_post(IDENTITY_VERIFICATIONS, sdk_authorization, request)
end

#create_identity_verification_attempt(identity_verification_id, attempt_request) ⇒ Object

Create a new attempt for an existing identity verification.

Parameters:



50
51
52
53
54
55
56
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 50

def create_identity_verification_attempt(identity_verification_id, attempt_request)
  api_client.invoke_post(
    build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS),
    sdk_authorization,
    attempt_request
  )
end

#get_identity_verification(identity_verification_id) ⇒ Object

Parameters:

  • identity_verification_id (String) 


34
35
36
37
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 34

def get_identity_verification(identity_verification_id)
  api_client.invoke_get(build_path(IDENTITY_VERIFICATIONS, identity_verification_id),
                        sdk_authorization)
end

#get_identity_verification_attempt(identity_verification_id, attempt_id) ⇒ Object

Parameters:

  • identity_verification_id (String)
  • attempt_id (String) 


68
69
70
71
72
73
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 68

def get_identity_verification_attempt(identity_verification_id, attempt_id)
  api_client.invoke_get(
    build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS, attempt_id),
    sdk_authorization
  )
end

#get_identity_verification_attempt_assets(identity_verification_id, attempt_id, query = nil) ⇒ Object

Retrieve the assets (face images, videos, and document images) captured during an identity verification attempt.

Parameters:

  • identity_verification_id (String)
  • attempt_id (String)
  • query (Hash, nil) (defaults to: nil) —

    pagination query parameters; supports :skip (Integer, default: 0) and :limit (Integer, default: 10)



89
90
91
92
93
94
95
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 89

def get_identity_verification_attempt_assets(identity_verification_id, attempt_id, query = nil)
  api_client.invoke_get(
    build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS, attempt_id, ASSETS),
    sdk_authorization,
    query
  )
end

#get_identity_verification_attempts(identity_verification_id) ⇒ Object

Parameters:

  • identity_verification_id (String) 


59
60
61
62
63
64
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 59

def get_identity_verification_attempts(identity_verification_id)
  api_client.invoke_get(
    build_path(IDENTITY_VERIFICATIONS, identity_verification_id, ATTEMPTS),
    sdk_authorization
  )
end

#get_identity_verification_pdf_report(identity_verification_id) ⇒ Object

Parameters:

  • identity_verification_id (String) 


76
77
78
79
80
81
 
# File 'lib/checkout_sdk/identities/identity_verification/identity_verification_client.rb', line 76

def get_identity_verification_pdf_report(identity_verification_id)
  api_client.invoke_get(
    build_path(IDENTITY_VERIFICATIONS, identity_verification_id, PDF_REPORT),
    sdk_authorization
  )
end