Class: Yoti::AmlProfile

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

Overview

Manages the AML check Profile object

Instance Method Summary collapse

Constructor Details

#initialize(given_names, family_name, aml_address, ssn = nil) ⇒ AmlProfile

Returns a new instance of AmlProfile.

Parameters:

  • given_names (String)
  • family_name (String)
  • aml_address (AmlAddress)
  • ssn (String) (defaults to: nil)

Raises:



10
11
12
13
14
15
16
17
18
 
# File 'lib/yoti/http/payloads/aml_profile.rb', line 10

def initialize(given_names, family_name, aml_address, ssn = nil)
  @given_names = given_names
  @family_name = family_name
  @ssn = ssn
  @address = aml_address

  raise AmlError, 'The AML request requires given names, family name and an ISO 3166 3-letter code.' if profile_invalid
  raise AmlError, 'Request for USA require a valid SSN and postcode.' if usa_invalid
end

Instance Method Details

#payload ⇒ Hash

Returns the AML check request body.

Returns:

  • (Hash) —

    the AML check request body



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/yoti/http/payloads/aml_profile.rb', line 21

def payload
  {
    given_names: @given_names,
    family_name: @family_name,
    ssn: @ssn,
    address: {
      country: @address.country,
      post_code: @address.post_code
    }
  }
end