Class: Yoti::AmlAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/yoti/http/payloads/aml_address.rb

Overview

Manages the AML check Address object

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(country, post_code = nil) ⇒ AmlAddress

Returns a new instance of AmlAddress.

Parameters:

  • country (String)
  • post_code (String) (defaults to: nil)

Raises:



14
15
16
17
18
19
 
# File 'lib/yoti/http/payloads/aml_address.rb', line 14

def initialize(country, post_code = nil)
  raise AmlError, 'AmlAddress requires a country.' if country.to_s.empty?

  @country = country
  @post_code = post_code
end

Instance Attribute Details

#country ⇒ String

Returns the country of residence in a ISO 3166 3-letter code format.

Returns:

  • (String) —

    the country of residence in a ISO 3166 3-letter code format



5
6
7
 
# File 'lib/yoti/http/payloads/aml_address.rb', line 5

def country
  @country
end

#post_code ⇒ String

Returns the postcode required for USA, optional otherwise.

Returns:

  • (String) —

    the postcode required for USA, optional otherwise



8
9
10
 
# File 'lib/yoti/http/payloads/aml_address.rb', line 8

def post_code
  @post_code
end