Class: PreludeSDK::Models::Intel::KYCMatchResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/prelude_sdk/models/intel/kyc_match_response.rb,
sig/prelude_sdk/models/intel/kyc_match_response.rbs

Overview

See Also:

  • PreludeSDK::Resources::Intel::KYC#match

Defined Under Namespace

Modules: AddressMatch, BirthdateMatch, CountryMatch, EmailMatch, FamilyNameMatch, GivenNameMatch, LocalityMatch, PostalCodeMatch, RegionMatch

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(address_match: nil, address_match_score: nil, birthdate_match: nil, country_code: nil, country_match: nil, email_match: nil, email_match_score: nil, family_name_match: nil, family_name_match_score: nil, given_name_match: nil, given_name_match_score: nil, locality_match: nil, locality_match_score: nil, operator: nil, phone_number: nil, postal_code_match: nil, region_match: nil, region_match_score: nil, request_id: nil) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::Intel::KYCMatchResponse for more details.

The per-attribute match result. Each <attribute>_match field is one of true, false, or not_available (the operator could not answer for that attribute). Fuzzy attributes additionally return a <attribute>_match_score (0-99 similarity) when they do not match exactly; the score is omitted on a match or when not_available.

Parameters:

  • address_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::AddressMatch) (defaults to: nil) —

    Whether the street address matched the operator's record.

  • address_match_score (Integer) (defaults to: nil) —

    Similarity score (0-99) for the address. Returned only on a non-match.

  • birthdate_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::BirthdateMatch) (defaults to: nil) —

    Whether the date of birth matched the operator's record. Compared exactly; never

  • country_code (String) (defaults to: nil) —

    The country code of the phone number.

  • country_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::CountryMatch) (defaults to: nil) —

    Whether the country matched the operator's record. Compared exactly; never score

  • email_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::EmailMatch) (defaults to: nil) —

    Whether the email address matched the operator's record.

  • email_match_score (Integer) (defaults to: nil) —

    Similarity score (0-99) for the email. Returned only on a non-match.

  • family_name_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::FamilyNameMatch) (defaults to: nil) —

    Whether the family name matched the operator's record.

  • family_name_match_score (Integer) (defaults to: nil) —

    Similarity score (0-99) for the family name. Returned only on a non-match.

  • given_name_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::GivenNameMatch) (defaults to: nil) —

    Whether the given name matched the operator's record.

  • given_name_match_score (Integer) (defaults to: nil) —

    Similarity score (0-99) for the given name. Returned only on a non-match.

  • locality_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::LocalityMatch) (defaults to: nil) —

    Whether the locality matched the operator's record.

  • locality_match_score (Integer) (defaults to: nil) —

    Similarity score (0-99) for the locality. Returned only on a non-match.

  • operator (String) (defaults to: nil) —

    The mobile operator that answered the match.

  • phone_number (String) (defaults to: nil) —

    The phone number that was matched, in E.164 format.

  • postal_code_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::PostalCodeMatch) (defaults to: nil) —

    Whether the postal code matched the operator's record. Compared exactly; never s

  • region_match (Symbol, PreludeSDK::Models::Intel::KYCMatchResponse::RegionMatch) (defaults to: nil) —

    Whether the region matched the operator's record.

  • region_match_score (Integer) (defaults to: nil) —

    Similarity score (0-99) for the region. Returned only on a non-match.

  • request_id (String) (defaults to: nil) —

    A string that identifies this specific request. Report it back to us to help us




# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 126

Instance Attribute Details

#address_match ⇒ Symbol, ...

Whether the street address matched the operator's record.

Returns:



12
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 12

optional :address_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::AddressMatch }

#address_match_score ⇒ Integer?

Similarity score (0-99) for the address. Returned only on a non-match.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


18
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 18

optional :address_match_score, Integer

#birthdate_match ⇒ Symbol, ...

Whether the date of birth matched the operator's record. Compared exactly; never scored.

Returns:



25
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 25

optional :birthdate_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::BirthdateMatch }

#country_code ⇒ String?

The country code of the phone number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 31

optional :country_code, String

#country_match ⇒ Symbol, ...

Whether the country matched the operator's record. Compared exactly; never scored.

Returns:



38
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 38

optional :country_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::CountryMatch }

#email_match ⇒ Symbol, ...

Whether the email address matched the operator's record.

Returns:



44
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 44

optional :email_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::EmailMatch }

#email_match_score ⇒ Integer?

Similarity score (0-99) for the email. Returned only on a non-match.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


50
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 50

optional :email_match_score, Integer

#family_name_match ⇒ Symbol, ...

Whether the family name matched the operator's record.

Returns:



56
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 56

optional :family_name_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::FamilyNameMatch }

#family_name_match_score ⇒ Integer?

Similarity score (0-99) for the family name. Returned only on a non-match.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


62
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 62

optional :family_name_match_score, Integer

#given_name_match ⇒ Symbol, ...

Whether the given name matched the operator's record.

Returns:



68
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 68

optional :given_name_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::GivenNameMatch }

#given_name_match_score ⇒ Integer?

Similarity score (0-99) for the given name. Returned only on a non-match.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


74
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 74

optional :given_name_match_score, Integer

#locality_match ⇒ Symbol, ...

Whether the locality matched the operator's record.

Returns:



80
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 80

optional :locality_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::LocalityMatch }

#locality_match_score ⇒ Integer?

Similarity score (0-99) for the locality. Returned only on a non-match.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


86
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 86

optional :locality_match_score, Integer

#operator ⇒ String?

The mobile operator that answered the match.

Parameters:

  • (String)

Returns:

  • (String, nil) 


92
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 92

optional :operator, String

#phone_number ⇒ String?

The phone number that was matched, in E.164 format.

Parameters:

  • (String)

Returns:

  • (String, nil) 


98
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 98

optional :phone_number, String

#postal_code_match ⇒ Symbol, ...

Whether the postal code matched the operator's record. Compared exactly; never scored.

Returns:



105
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 105

optional :postal_code_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::PostalCodeMatch }

#region_match ⇒ Symbol, ...

Whether the region matched the operator's record.

Returns:



111
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 111

optional :region_match, enum: -> { PreludeSDK::Models::Intel::KYCMatchResponse::RegionMatch }

#region_match_score ⇒ Integer?

Similarity score (0-99) for the region. Returned only on a non-match.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


117
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 117

optional :region_match_score, Integer

#request_id ⇒ String?

A string that identifies this specific request. Report it back to us to help us diagnose your issues.

Parameters:

  • (String)

Returns:

  • (String, nil) 


124
 
# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 124

optional :request_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/prelude_sdk/models/intel/kyc_match_response.rb', line 184

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


144
 
# File 'sig/prelude_sdk/models/intel/kyc_match_response.rbs', line 144

def to_hash: -> {