Class: CybridApiBank::IdentityVerificationsBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityVerificationsBankApi

Returns a new instance of IdentityVerificationsBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_identity_verification(post_identity_verification_bank_model, opts = {}) ⇒ IdentityVerificationBankModel

Create Identity Verification Creates an Identity Verification. ## Identity Verifications Identity Verifications confirm an individual’s identity with for the purpose of inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Cybrid performing the verification or working with partners to accept their KYC/AML process and have it attested to in our platform. ## State | State | Description | |——-|————-| | storing | The Platform is storing the identity verification details in our private store | | waiting | The Platform is waiting for the customer to start the identity verification process | | pending | The Platform is waiting for the customer to finish the identity verification process | | reviewing | The Platform is waiting for compliance to review the identity verification results | | expired | The identity verification process has expired | | completed | The identity verification process has been completed | ## Outcome | State | Description | |——-|————-| | passed | The customer has passed the identity verification process | | failed | The customer has failed the identity verification process | ## Failure Codes | Code | Description | |——-|————-| | id_check_failure | Failure due to an issue verifying the provided ID | | id_quality_check_failure | Failure due to an issue verifying the provided ID based on the image quality | | id_barcode_check_failure | Failure due to an issue verifying the provided ID based on the barcode | | id_mrz_check_failure | Failure due to an issue verifying the provided ID based on the machine-readable zone (MRZ) | | id_presence_check_failure | Failure due to an issue verifying the provided ID based on the presence of the ID | | id_expiration_check_failure | Failure due to an issue verifying the provided ID based on the expiration date | | id_double_side_check_failure | Failure due to an issue verifying the provided ID based on both sides not being provided | | id_type_allowed_check_failure | Failure due to an issue verifying the provided ID based on the type provided | | id_country_allowed_check_failure | Failure due to an issue verifying the provided ID based on the issuing country | | id_digital_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a digital replica | | id_paper_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a paper replica | | database_check_failure | Failure due to an issue verifying the provided information against authoritative data sources | | selfie_failure | Failure due to an issue verifying the provided selfie photo | | country_comparison_check_failure | Failure due the customer verification being performed out of country | | duplicate_person_check_failure | Failure due to a customer already existing for this person | | prohibited_person_check_failure | Failure due to a person being on prohibited from accessing the service | | name_check_failure | Failure due to an issue verifying the name of the person | | address_check_failure | Failure due to an issue verifying the address of the person | | dob_check_failure | Failure due to an issue verifying the date of birth of the person | | id_number_check_failure | Failure due to an issue verifying an identification number of the person | | phone_number_check_failure | Failure due to an issue verifying the phone number of the person | | email_address_check_failure | Failure due to an issue verifying the email address of the person | | compliance_rejection | Failure due to compliance rejecting the identity verification | | plaid_failure | Failure due to an issue interacting with Plaid | | plaid_item_login_required | Failure due to the Plaid token for the account requiring re-login | | plaid_invalid_product | Failure due to the Plaid product not being supported (contact support) | | plaid_no_accounts | Failure due to the Plaid token having access to no accounts | | plaid_item_not_found | Failure due to Plaid not being able to find the associated account | | decision_timeout | Failure due to an issue verifying the email address of the person | | requested_failure | In sandbox, the caller requested that the process failed | | deleted_account | Failure due to the bank account having been deleted before a decision was made | Required scope: identity_verifications:execute

Parameters:

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 27

def create_identity_verification(post_identity_verification_bank_model, opts = {})
  data, _status_code, _headers = create_identity_verification_with_http_info(post_identity_verification_bank_model, opts)
  data
end

#create_identity_verification_with_http_info(post_identity_verification_bank_model, opts = {}) ⇒ Array<(IdentityVerificationBankModel, Integer, Hash)>

Create Identity Verification Creates an Identity Verification. ## Identity Verifications Identity Verifications confirm an individual&#39;s identity with for the purpose of inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Cybrid performing the verification or working with partners to accept their KYC/AML process and have it attested to in our platform. ## State | State | Description | |——-|————-| | storing | The Platform is storing the identity verification details in our private store | | waiting | The Platform is waiting for the customer to start the identity verification process | | pending | The Platform is waiting for the customer to finish the identity verification process | | reviewing | The Platform is waiting for compliance to review the identity verification results | | expired | The identity verification process has expired | | completed | The identity verification process has been completed | ## Outcome | State | Description | |——-|————-| | passed | The customer has passed the identity verification process | | failed | The customer has failed the identity verification process | ## Failure Codes | Code | Description | |——-|————-| | id_check_failure | Failure due to an issue verifying the provided ID | | id_quality_check_failure | Failure due to an issue verifying the provided ID based on the image quality | | id_barcode_check_failure | Failure due to an issue verifying the provided ID based on the barcode | | id_mrz_check_failure | Failure due to an issue verifying the provided ID based on the machine-readable zone (MRZ) | | id_presence_check_failure | Failure due to an issue verifying the provided ID based on the presence of the ID | | id_expiration_check_failure | Failure due to an issue verifying the provided ID based on the expiration date | | id_double_side_check_failure | Failure due to an issue verifying the provided ID based on both sides not being provided | | id_type_allowed_check_failure | Failure due to an issue verifying the provided ID based on the type provided | | id_country_allowed_check_failure | Failure due to an issue verifying the provided ID based on the issuing country | | id_digital_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a digital replica | | id_paper_replica_check_failure | Failure due to an issue verifying the provided ID based on it being a paper replica | | database_check_failure | Failure due to an issue verifying the provided information against authoritative data sources | | selfie_failure | Failure due to an issue verifying the provided selfie photo | | country_comparison_check_failure | Failure due the customer verification being performed out of country | | duplicate_person_check_failure | Failure due to a customer already existing for this person | | prohibited_person_check_failure | Failure due to a person being on prohibited from accessing the service | | name_check_failure | Failure due to an issue verifying the name of the person | | address_check_failure | Failure due to an issue verifying the address of the person | | dob_check_failure | Failure due to an issue verifying the date of birth of the person | | id_number_check_failure | Failure due to an issue verifying an identification number of the person | | phone_number_check_failure | Failure due to an issue verifying the phone number of the person | | email_address_check_failure | Failure due to an issue verifying the email address of the person | | compliance_rejection | Failure due to compliance rejecting the identity verification | | plaid_failure | Failure due to an issue interacting with Plaid | | plaid_item_login_required | Failure due to the Plaid token for the account requiring re-login | | plaid_invalid_product | Failure due to the Plaid product not being supported (contact support) | | plaid_no_accounts | Failure due to the Plaid token having access to no accounts | | plaid_item_not_found | Failure due to Plaid not being able to find the associated account | | decision_timeout | Failure due to an issue verifying the email address of the person | | requested_failure | In sandbox, the caller requested that the process failed | | deleted_account | Failure due to the bank account having been deleted before a decision was made | Required scope: identity_verifications:execute

Parameters:

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 37

def create_identity_verification_with_http_info(post_identity_verification_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityVerificationsBankApi.create_identity_verification ...'
  end
  # verify the required parameter 'post_identity_verification_bank_model' is set
  if @api_client.config.client_side_validation && post_identity_verification_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_identity_verification_bank_model' when calling IdentityVerificationsBankApi.create_identity_verification"
  end
  # resource path
  local_var_path = '/api/identity_verifications'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_identity_verification_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"IdentityVerificationsBankApi.create_identity_verification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityVerificationsBankApi#create_identity_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_identity_verification(identity_verification_guid, opts = {}) ⇒ IdentityVerificationWithDetailsBankModel

Get Identity Verification Retrieves an identity verification. Required scope: identity_verifications:read

Parameters:

  • identity_verification_guid (String) —

    Identifier for the identity verification.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_pii (Boolean) —

    Include PII in the response.

Returns:



96
97
98
99
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 96

def get_identity_verification(identity_verification_guid, opts = {})
  data, _status_code, _headers = get_identity_verification_with_http_info(identity_verification_guid, opts)
  data
end

#get_identity_verification_with_http_info(identity_verification_guid, opts = {}) ⇒ Array<(IdentityVerificationWithDetailsBankModel, Integer, Hash)>

Get Identity Verification Retrieves an identity verification. Required scope: identity_verifications:read

Parameters:

  • identity_verification_guid (String) —

    Identifier for the identity verification.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_pii (Boolean) —

    Include PII in the response.

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 107

def get_identity_verification_with_http_info(identity_verification_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityVerificationsBankApi.get_identity_verification ...'
  end
  # verify the required parameter 'identity_verification_guid' is set
  if @api_client.config.client_side_validation && identity_verification_guid.nil?
    fail ArgumentError, "Missing the required parameter 'identity_verification_guid' when calling IdentityVerificationsBankApi.get_identity_verification"
  end
  # resource path
  local_var_path = '/api/identity_verifications/{identity_verification_guid}'.sub('{' + 'identity_verification_guid' + '}', CGI.escape(identity_verification_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_pii'] = opts[:'include_pii'] if !opts[:'include_pii'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationWithDetailsBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"IdentityVerificationsBankApi.get_identity_verification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityVerificationsBankApi#get_identity_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_identity_verifications(opts = {}) ⇒ IdentityVerificationListBankModel

List Identity Verifications Retrieves a list of identity verifications. Required scope: identity_verifications:read

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated guids to list identity verifications for.

  • :bank_guid (String) —

    Comma separated bank_guids to list identity verifications for.

  • :customer_guid (String) —

    Comma separated customer_guids to list identity verifications for.

  • :state (String) —

    Comma separated states to list identity verifications for.

  • :type (String) —

    Comma separated types to list identity verifications for.

Returns:



167
168
169
170
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 167

def list_identity_verifications(opts = {})
  data, _status_code, _headers = list_identity_verifications_with_http_info(opts)
  data
end

#list_identity_verifications_with_http_info(opts = {}) ⇒ Array<(IdentityVerificationListBankModel, Integer, Hash)>

List Identity Verifications Retrieves a list of identity verifications. Required scope: identity_verifications:read

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated guids to list identity verifications for.

  • :bank_guid (String) —

    Comma separated bank_guids to list identity verifications for.

  • :customer_guid (String) —

    Comma separated customer_guids to list identity verifications for.

  • :state (String) —

    Comma separated states to list identity verifications for.

  • :type (String) —

    Comma separated types to list identity verifications for.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb', line 183

def list_identity_verifications_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityVerificationsBankApi.list_identity_verifications ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling IdentityVerificationsBankApi.list_identity_verifications, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IdentityVerificationsBankApi.list_identity_verifications, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling IdentityVerificationsBankApi.list_identity_verifications, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/identity_verifications'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IdentityVerificationListBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"IdentityVerificationsBankApi.list_identity_verifications",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityVerificationsBankApi#list_identity_verifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end