trinsic_api 3.2.1 → 3.3.0.pre.alpha2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. checksums.yaml +4 -4
  2. data/docs/BrazilCnhProviderOutput.md +2 -0
  3. data/docs/BrazilCpfCheckInput.md +3 -3
  4. data/docs/BrazilCpfProviderOutput.md +1 -1
  5. data/docs/BrazilDigitalCnhInput.md +1 -1
  6. data/docs/ConnectIdAgeVerification.md +9 -1
  7. data/docs/ConnectIdInput.md +18 -0
  8. data/docs/CreateDirectProviderSessionRequest.md +2 -0
  9. data/docs/CreateHostedProviderSessionRequest.md +2 -0
  10. data/docs/CzechBankIdInput.md +18 -0
  11. data/docs/DeveloperApi.md +153 -0
  12. data/docs/DigilockerAadhaarProviderOutput.md +1 -1
  13. data/docs/FinnishTrustNetworkAddressOutput.md +22 -0
  14. data/docs/FinnishTrustNetworkInput.md +18 -0
  15. data/docs/FinnishTrustNetworkProviderOutput.md +2 -0
  16. data/docs/GetAttachmentResponse.md +2 -0
  17. data/docs/GetSessionResultRequest.md +3 -1
  18. data/docs/GetSessionResultResponse.md +3 -1
  19. data/docs/HPKETestRequest.md +22 -0
  20. data/docs/HPKETestVPRequest.md +20 -0
  21. data/docs/IdemiaMobileIdProviderOutput.md +1 -5
  22. data/docs/IndiaPanLookupProviderOutput.md +1 -1
  23. data/docs/IndonesiaDukcapilMatchInput.md +1 -1
  24. data/docs/JapanMyNumberProviderOutput.md +24 -0
  25. data/docs/JordanSanadInput.md +18 -0
  26. data/docs/MitIdAddressOutput.md +28 -0
  27. data/docs/MitIdProviderOutput.md +3 -1
  28. data/docs/PolandMobywatelMatchInput.md +1 -1
  29. data/docs/Provider.md +2 -0
  30. data/docs/ProviderInput.md +10 -0
  31. data/docs/ProviderOutput.md +8 -0
  32. data/docs/RecommendProviderInformation.md +2 -0
  33. data/docs/RecommendProvidersRequest.md +1 -1
  34. data/docs/RevolutProviderOutput.md +28 -0
  35. data/docs/SanadProviderOutput.md +28 -0
  36. data/docs/SaudiArabiaNafathAddress.md +50 -0
  37. data/docs/SaudiArabiaNafathCitizenAttributes.md +68 -0
  38. data/docs/SaudiArabiaNafathHeadOfHousehold.md +26 -0
  39. data/docs/SaudiArabiaNafathProviderOutput.md +38 -0
  40. data/docs/SaudiArabiaNafathResidentAttributes.md +68 -0
  41. data/docs/SaudiArabiaNafathVisitorAttributes.md +72 -0
  42. data/docs/SessionsApi.md +2 -2
  43. data/docs/SignzyIndiaAadhaarFetchProviderOutput.md +1 -1
  44. data/docs/SingpassPersonalCatalog.md +2 -2
  45. data/docs/SwedenBankIdProviderOutput.md +7 -3
  46. data/docs/TrinsicHPKEBundle.md +24 -0
  47. data/docs/TrinsicHPKEMetadata.md +30 -0
  48. data/docs/TrinsicTestDatabaseLookupInput.md +1 -1
  49. data/docs/UkEvisaLookupInput.md +1 -1
  50. data/docs/UsaArizonaWalletInput.md +18 -0
  51. data/docs/VerificationProfileResponse.md +2 -0
  52. data/docs/VerificationProfilesApi.md +3 -1
  53. data/docs/YotiStructuredPostalAddress.md +1 -1
  54. data/lib/trinsic_api/api/developer_api.rb +156 -0
  55. data/lib/trinsic_api/api/verification_profiles_api.rb +3 -0
  56. data/lib/trinsic_api/api_client.rb +1 -0
  57. data/lib/trinsic_api/models/brazil_cnh_provider_output.rb +12 -1
  58. data/lib/trinsic_api/models/brazil_cpf_check_input.rb +12 -22
  59. data/lib/trinsic_api/models/brazil_cpf_provider_output.rb +1 -1
  60. data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +1 -1
  61. data/lib/trinsic_api/models/connect_id_age_verification.rb +46 -2
  62. data/lib/trinsic_api/models/connect_id_input.rb +149 -0
  63. data/lib/trinsic_api/models/create_direct_provider_session_request.rb +28 -1
  64. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +28 -1
  65. data/lib/trinsic_api/models/czech_bank_id_input.rb +149 -0
  66. data/lib/trinsic_api/models/digilocker_aadhaar_provider_output.rb +1 -1
  67. data/lib/trinsic_api/models/finnish_trust_network_address_output.rb +171 -0
  68. data/lib/trinsic_api/models/finnish_trust_network_input.rb +149 -0
  69. data/lib/trinsic_api/models/finnish_trust_network_provider_output.rb +12 -1
  70. data/lib/trinsic_api/models/get_attachment_response.rb +12 -1
  71. data/lib/trinsic_api/models/get_session_result_request.rb +15 -4
  72. data/lib/trinsic_api/models/get_session_result_response.rb +16 -5
  73. data/lib/trinsic_api/models/hpke_test_request.rb +219 -0
  74. data/lib/trinsic_api/models/hpke_test_vp_request.rb +192 -0
  75. data/lib/trinsic_api/models/idemia_mobile_id_provider_output.rb +1 -23
  76. data/lib/trinsic_api/models/india_pan_lookup_provider_output.rb +1 -1
  77. data/lib/trinsic_api/models/indonesia_dukcapil_match_input.rb +1 -1
  78. data/lib/trinsic_api/models/japan_my_number_provider_output.rb +183 -0
  79. data/lib/trinsic_api/models/jordan_sanad_input.rb +164 -0
  80. data/lib/trinsic_api/models/mit_id_address_output.rb +204 -0
  81. data/lib/trinsic_api/models/mit_id_provider_output.rb +16 -5
  82. data/lib/trinsic_api/models/poland_mobywatel_match_input.rb +1 -1
  83. data/lib/trinsic_api/models/provider.rb +14 -1
  84. data/lib/trinsic_api/models/provider_input.rb +56 -1
  85. data/lib/trinsic_api/models/provider_output.rb +45 -1
  86. data/lib/trinsic_api/models/recommend_provider_information.rb +14 -1
  87. data/lib/trinsic_api/models/recommend_providers_request.rb +1 -1
  88. data/lib/trinsic_api/models/revolut_provider_output.rb +204 -0
  89. data/lib/trinsic_api/models/sanad_provider_output.rb +205 -0
  90. data/lib/trinsic_api/models/saudi_arabia_nafath_address.rb +325 -0
  91. data/lib/trinsic_api/models/saudi_arabia_nafath_citizen_attributes.rb +426 -0
  92. data/lib/trinsic_api/models/saudi_arabia_nafath_head_of_household.rb +193 -0
  93. data/lib/trinsic_api/models/saudi_arabia_nafath_provider_output.rb +260 -0
  94. data/lib/trinsic_api/models/saudi_arabia_nafath_resident_attributes.rb +426 -0
  95. data/lib/trinsic_api/models/saudi_arabia_nafath_visitor_attributes.rb +446 -0
  96. data/lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb +1 -1
  97. data/lib/trinsic_api/models/singpass_personal_catalog.rb +9 -9
  98. data/lib/trinsic_api/models/sweden_bank_id_provider_output.rb +24 -2
  99. data/lib/trinsic_api/models/trinsic_hpke_bundle.rb +246 -0
  100. data/lib/trinsic_api/models/trinsic_hpke_metadata.rb +327 -0
  101. data/lib/trinsic_api/models/trinsic_test_database_lookup_input.rb +1 -1
  102. data/lib/trinsic_api/models/uk_evisa_lookup_input.rb +1 -1
  103. data/lib/trinsic_api/models/usa_arizona_wallet_input.rb +149 -0
  104. data/lib/trinsic_api/models/verification_profile_response.rb +28 -1
  105. data/lib/trinsic_api/version.rb +1 -1
  106. data/lib/trinsic_api.rb +21 -0
  107. data/spec/api/developer_api_spec.rb +60 -0
  108. data/spec/api/verification_profiles_api_spec.rb +1 -0
  109. data/spec/models/brazil_cnh_provider_output_spec.rb +6 -0
  110. data/spec/models/connect_id_age_verification_spec.rb +24 -0
  111. data/spec/models/connect_id_input_spec.rb +36 -0
  112. data/spec/models/create_direct_provider_session_request_spec.rb +6 -0
  113. data/spec/models/create_hosted_provider_session_request_spec.rb +6 -0
  114. data/spec/models/czech_bank_id_input_spec.rb +36 -0
  115. data/spec/models/finnish_trust_network_address_output_spec.rb +48 -0
  116. data/spec/models/finnish_trust_network_input_spec.rb +36 -0
  117. data/spec/models/finnish_trust_network_provider_output_spec.rb +6 -0
  118. data/spec/models/get_attachment_response_spec.rb +6 -0
  119. data/spec/models/get_session_result_request_spec.rb +6 -0
  120. data/spec/models/get_session_result_response_spec.rb +6 -0
  121. data/spec/models/hpke_test_request_spec.rb +48 -0
  122. data/spec/models/hpke_test_vp_request_spec.rb +42 -0
  123. data/spec/models/idemia_mobile_id_provider_output_spec.rb +0 -12
  124. data/spec/models/japan_my_number_provider_output_spec.rb +54 -0
  125. data/spec/models/jordan_sanad_input_spec.rb +36 -0
  126. data/spec/models/mit_id_address_output_spec.rb +66 -0
  127. data/spec/models/mit_id_provider_output_spec.rb +6 -0
  128. data/spec/models/provider_input_spec.rb +30 -0
  129. data/spec/models/provider_output_spec.rb +24 -0
  130. data/spec/models/provider_spec.rb +6 -0
  131. data/spec/models/recommend_provider_information_spec.rb +6 -0
  132. data/spec/models/revolut_provider_output_spec.rb +66 -0
  133. data/spec/models/sanad_provider_output_spec.rb +66 -0
  134. data/spec/models/saudi_arabia_nafath_address_spec.rb +132 -0
  135. data/spec/models/saudi_arabia_nafath_citizen_attributes_spec.rb +186 -0
  136. data/spec/models/saudi_arabia_nafath_head_of_household_spec.rb +60 -0
  137. data/spec/models/saudi_arabia_nafath_provider_output_spec.rb +96 -0
  138. data/spec/models/saudi_arabia_nafath_resident_attributes_spec.rb +186 -0
  139. data/spec/models/saudi_arabia_nafath_visitor_attributes_spec.rb +198 -0
  140. data/spec/models/singpass_personal_catalog_spec.rb +1 -1
  141. data/spec/models/sweden_bank_id_provider_output_spec.rb +12 -0
  142. data/spec/models/trinsic_hpke_bundle_spec.rb +54 -0
  143. data/spec/models/trinsic_hpke_metadata_spec.rb +72 -0
  144. data/spec/models/usa_arizona_wallet_input_spec.rb +36 -0
  145. data/spec/models/verification_profile_response_spec.rb +6 -0
  146. metadata +375 -291
data/docs/Provider.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The unique identifier of the provider | |
8
8
  | **name** | **String** | The display name of the provider | |
9
+ | **localized_display_names** | **Hash<String, String>** | Localized display names for the Provider, if any, keyed by lowercase BCP 47 language codes (eg \"fr\"). If a particular language code is not present, fall back to `name`. This should not be confused for the list of languages the Provider officially supports. | [optional] |
9
10
  | **logo_url** | **String** | The URL of the provider's logo | |
10
11
  | **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
11
12
  | **regions** | **Array<String>** | Specific regions supported by this provider | |
@@ -34,6 +35,7 @@ require 'trinsic_api'
34
35
  instance = TrinsicApi::Provider.new(
35
36
  id: yoti,
36
37
  name: Yoti,
38
+ localized_display_names: {"en":"Brazil CPF","pt":"Verificação CPF"},
37
39
  logo_url: https://cdn.trinsic.id/providers/yoti.png,
38
40
  subtext: dmv.ca.gov,
39
41
  regions: ["Europe"],
@@ -29,12 +29,16 @@
29
29
  | **korea_telco_match** | [**KoreaTelcoMatchInput**](KoreaTelcoMatchInput.md) | Input for the `korea-telco-match` provider | [optional] |
30
30
  | **brazil_cpf_lookup** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `brazil-cpf-lookup` provider | [optional] |
31
31
  | **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `brazil-digital-cnh` provider | [optional] |
32
+ | **jordan_sanad** | [**JordanSanadInput**](JordanSanadInput.md) | Input for the `jordan-sanad` provider. | [optional] |
32
33
  | **philippines_philsys_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `philippines-philsys-match` provider | [optional] |
33
34
  | **philippines_physical_national_id_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `philippines-physical-national-id-qr` provider | [optional] |
34
35
  | **philippines_digital_national_id_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `philippines-digital-national-id-qr` provider | [optional] |
35
36
  | **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the `smart-id` provider | [optional] |
36
37
  | **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the `mobile-id` provider | [optional] |
37
38
  | **netherlands_idin** | [**IdinInput**](IdinInput.md) | Input for the `netherlands-idin` provider | [optional] |
39
+ | **finnish_trust_network** | [**FinnishTrustNetworkInput**](FinnishTrustNetworkInput.md) | Input for the `finnish-trust-network` provider. | [optional] |
40
+ | **czech_bank_id** | [**CzechBankIdInput**](CzechBankIdInput.md) | Input for the `czech-bank-id` provider. | [optional] |
41
+ | **australia_connect_id** | [**ConnectIdInput**](ConnectIdInput.md) | Input for the `australia-connect-id` provider. | [optional] |
38
42
  | **italy_spid** | [**SpidInput**](SpidInput.md) | Input for the `italy-spid` provider | [optional] |
39
43
  | **google_wallet** | [**GoogleWalletInput**](GoogleWalletInput.md) | Input for the `google-wallet` provider | [optional] |
40
44
  | **apple_wallet** | [**AppleWalletInput**](AppleWalletInput.md) | Input for the `apple-wallet` provider | [optional] |
@@ -53,6 +57,7 @@
53
57
  | **panama_cedula_lookup** | [**PanamaCedulaLookupInput**](PanamaCedulaLookupInput.md) | Input for the `panama-cedula-lookup` provider | [optional] |
54
58
  | **peru_dni_lookup** | [**PeruDniLookupInput**](PeruDniLookupInput.md) | Input for the `peru-dni-lookup` provider | [optional] |
55
59
  | **uk_evisa_lookup** | [**UkEvisaLookupInput**](UkEvisaLookupInput.md) | Input for the `uk-evisa-lookup` provider | [optional] |
60
+ | **usa_arizona_wallet** | [**UsaArizonaWalletInput**](UsaArizonaWalletInput.md) | Input for the `usa-arizona-wallet` provider | [optional] |
56
61
  | **usa_california_dmv** | [**UsaCaliforniaDmvInput**](UsaCaliforniaDmvInput.md) | Input for the `usa-california-dmv` provider | [optional] |
57
62
  | **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-database-lookup` provider | [optional] |
58
63
  | **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-sub-providers` provider | [optional] |
@@ -88,12 +93,16 @@ instance = TrinsicApi::ProviderInput.new(
88
93
  korea_telco_match: null,
89
94
  brazil_cpf_lookup: null,
90
95
  brazil_digital_cnh: null,
96
+ jordan_sanad: null,
91
97
  philippines_philsys_match: null,
92
98
  philippines_physical_national_id_qr: null,
93
99
  philippines_digital_national_id_qr: null,
94
100
  smart_id: null,
95
101
  mobile_id: null,
96
102
  netherlands_idin: null,
103
+ finnish_trust_network: null,
104
+ czech_bank_id: null,
105
+ australia_connect_id: null,
97
106
  italy_spid: null,
98
107
  google_wallet: null,
99
108
  apple_wallet: null,
@@ -112,6 +121,7 @@ instance = TrinsicApi::ProviderInput.new(
112
121
  panama_cedula_lookup: null,
113
122
  peru_dni_lookup: null,
114
123
  uk_evisa_lookup: null,
124
+ usa_arizona_wallet: null,
115
125
  usa_california_dmv: null,
116
126
  trinsic_test_database_lookup: null,
117
127
  trinsic_test_sub_providers: null
@@ -54,6 +54,8 @@
54
54
  | **china_resident_id_match** | [**ChinaResidentIdMatchOutput**](ChinaResidentIdMatchOutput.md) | Exposed properties for the `china-resident-id-match` Provider which do not directly map to the normalized IdentityData model. | [optional] |
55
55
  | **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) | Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
56
56
  | **itsme** | [**ItsmeProviderOutput**](ItsmeProviderOutput.md) | Exposed properties for the `itsme` Provider which do not directly map to the normalized IdentityData model. | [optional] |
57
+ | **japan_mynumber** | [**JapanMyNumberProviderOutput**](JapanMyNumberProviderOutput.md) | Verified attributes for the `japan-mynumber` provider, including the original sex code. | [optional] |
58
+ | **jordan_sanad** | [**SanadProviderOutput**](SanadProviderOutput.md) | Exposed properties for the `jordan-sanad` Provider which do not directly map to the normalized IdentityData model. | [optional] |
57
59
  | **kenya_nid_lookup_2** | [**KenyaNidLookup2ProviderOutput**](KenyaNidLookup2ProviderOutput.md) | Exposed properties for the `kenya-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
58
60
  | **kenya_nid_lookup_3** | [**KenyaNidLookup3ProviderOutput**](KenyaNidLookup3ProviderOutput.md) | Exposed properties for the `kenya-nid-lookup-3` Provider which do not directly map to the normalized IdentityData model. | [optional] |
59
61
  | **kenya_nid_match_2** | [**KenyaNidMatch2ProviderOutput**](KenyaNidMatch2ProviderOutput.md) | Exposed properties for the `kenya-nid-match-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
@@ -67,6 +69,7 @@
67
69
  | **nigeria_nin_lookup_3** | [**NigeriaNinLookup3ProviderOutput**](NigeriaNinLookup3ProviderOutput.md) | Exposed properties for the `nigeria-nin-lookup-3` Provider which do not directly map to the normalized IdentityData model. | [optional] |
68
70
  | **nigeria_nin_match_2** | [**NigeriaNinMatch2ProviderOutput**](NigeriaNinMatch2ProviderOutput.md) | Exposed properties for the `nigeria-nin-match-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
69
71
  | **oneid** | [**OneIdProviderOutput**](OneIdProviderOutput.md) | Exposed properties for the `oneid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
72
+ | **revolut** | [**RevolutProviderOutput**](RevolutProviderOutput.md) | Identity claims returned by Revolut. | [optional] |
70
73
  | **peru_dni_lookup** | [**PeruDniProviderOutput**](PeruDniProviderOutput.md) | Exposed properties for the `peru-dni-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
71
74
  | **norway_bankid** | [**NorwegianBankIdProviderOutput**](NorwegianBankIdProviderOutput.md) | Exposed properties for the `norway-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
72
75
  | **philippines_digital_national_id_qr** | [**PhilippinesDigitalNidProviderOutput**](PhilippinesDigitalNidProviderOutput.md) | Exposed properties for the `philippines-digital-national-id-qr` Provider which do not directly map to the normalized IdentityData model. | [optional] |
@@ -75,6 +78,7 @@
75
78
  | **poland_mobywatel_match** | [**PolandMobywatelMatchProviderOutput**](PolandMobywatelMatchProviderOutput.md) | Exposed properties for the `poland-mobywatel-match` Provider which do not directly map to the normalized IdentityData model. | [optional] |
76
79
  | **post_office_easyid** | [**PostOfficeEasyIdProviderOutput**](PostOfficeEasyIdProviderOutput.md) | Exposed properties for the `post-office-easyid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
77
80
  | **samsung_wallet** | [**SamsungWalletProviderOutput**](SamsungWalletProviderOutput.md) | Exposed properties for the `samsung-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
81
+ | **saudi_arabia_nafath** | [**SaudiArabiaNafathProviderOutput**](SaudiArabiaNafathProviderOutput.md) | Exposed properties for the `saudi-arabia-nafath` Provider which do not directly map to the normalized IdentityData model. | [optional] |
78
82
  | **singpass_login** | [**SingpassLoginProviderOutput**](SingpassLoginProviderOutput.md) | Exposed properties for the `singpass-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
79
83
  | **singpass_myinfo** | [**SingpassMyInfoProviderOutput**](SingpassMyInfoProviderOutput.md) | Exposed properties for the `singpass-myinfo` Provider which do not directly map to the normalized IdentityData model. | [optional] |
80
84
  | **smart_id** | [**SmartIdProviderOutput**](SmartIdProviderOutput.md) | Exposed properties for the `smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
@@ -149,6 +153,8 @@ instance = TrinsicApi::ProviderOutput.new(
149
153
  china_resident_id_match: null,
150
154
  italy_spid: null,
151
155
  itsme: null,
156
+ japan_mynumber: null,
157
+ jordan_sanad: null,
152
158
  kenya_nid_lookup_2: null,
153
159
  kenya_nid_lookup_3: null,
154
160
  kenya_nid_match_2: null,
@@ -162,6 +168,7 @@ instance = TrinsicApi::ProviderOutput.new(
162
168
  nigeria_nin_lookup_3: null,
163
169
  nigeria_nin_match_2: null,
164
170
  oneid: null,
171
+ revolut: null,
165
172
  peru_dni_lookup: null,
166
173
  norway_bankid: null,
167
174
  philippines_digital_national_id_qr: null,
@@ -170,6 +177,7 @@ instance = TrinsicApi::ProviderOutput.new(
170
177
  poland_mobywatel_match: null,
171
178
  post_office_easyid: null,
172
179
  samsung_wallet: null,
180
+ saudi_arabia_nafath: null,
173
181
  singpass_login: null,
174
182
  singpass_myinfo: null,
175
183
  smart_id: null,
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The ID of the provider | [readonly] |
8
8
  | **name** | **String** | The friendly, human-readable name of the provider | [readonly] |
9
+ | **localized_display_names** | **Hash<String, String>** | Localized display names for the Provider, if any, keyed by lowercase BCP 47 language codes (eg \"fr\"). If a particular language code is not present, fall back to `name`. This should not be confused for the list of languages the Provider officially supports. | [optional][readonly] |
9
10
  | **logo_url** | **String** | A URL pointing to the provider's logo | [readonly] |
10
11
  | **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | [readonly] |
11
12
  | **health** | **String** | The current health status of the provider | [readonly] |
@@ -22,6 +23,7 @@ require 'trinsic_api'
22
23
  instance = TrinsicApi::RecommendProviderInformation.new(
23
24
  id: null,
24
25
  name: null,
26
+ localized_display_names: {"en":"Brazil CPF","pt":"Verificação CPF"},
25
27
  logo_url: null,
26
28
  subtext: dmv.ca.gov,
27
29
  health: online | offline,
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **verification_profile_id** | **String** | The ID of the VerificationProfile to use for this recommendation. | |
8
- | **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. | [optional] |
8
+ | **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. When no location can be determined from this information, all eligible providers are returned in the remainder. | [optional] |
9
9
  | **health** | [**RecommendProviderHealthOption**](RecommendProviderHealthOption.md) | Filter providers by health status. | [optional] |
10
10
 
11
11
  ## Example
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::RevolutProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subject** | **String** | The Revolut subject identifier. | [optional] |
8
+ | **name** | **String** | The individual's full name. | [optional] |
9
+ | **email** | **String** | The email address returned by Revolut. | [optional] |
10
+ | **email_verified** | **Boolean** | Whether Revolut verified the email address. | [optional] |
11
+ | **phone** | **String** | The phone number in E.164 format. | [optional] |
12
+ | **phone_verified** | **Boolean** | Whether Revolut verified the phone number. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::RevolutProviderOutput.new(
20
+ subject: revolut-subject-123,
21
+ name: Jane Doe,
22
+ email: jane@example.com,
23
+ email_verified: false,
24
+ phone: +447700900123,
25
+ phone_verified: true
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::SanadProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_number** | **String** | The national number (الرقم الوطني). This is a ten-digit number, with leading zeros preserved. The number is different from the identity-card number. | [optional] |
8
+ | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
9
+ | **full_name** | **String** | The full name of the individual. | [optional] |
10
+ | **document_number** | **String** | The identity-card number, separate from the national number. The format is three letters and five digits. | [optional] |
11
+ | **expiration_date** | **Date** | The document expiration date. | [optional] |
12
+ | **qr_created_date** | **Date** | The QR creation date, not the document's issue date. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::SanadProviderOutput.new(
20
+ national_number: 0012345678,
21
+ date_of_birth: Tue Feb 29 00:00:00 UTC 2000,
22
+ full_name: شخص تجريبي للاختبار,
23
+ document_number: TST00001,
24
+ expiration_date: Thu Jan 31 00:00:00 UTC 2030,
25
+ qr_created_date: Thu Jan 15 00:00:00 UTC 2026
26
+ )
27
+ ```
28
+
@@ -0,0 +1,50 @@
1
+ # TrinsicApi::SaudiArabiaNafathAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **building_number** | **String** | Building number. | [optional] |
8
+ | **street** | **String** | Street name in the session locale. Arabic when the session locale is ar, and English when it is en. streetSecondary is the other language. | [optional] |
9
+ | **district** | **String** | District or neighborhood in the session locale. Arabic when the session locale is ar, and English when it is en. districtSecondary is the other language. | [optional] |
10
+ | **city** | **String** | City in the session locale. Arabic when the session locale is ar, and English when it is en. citySecondary is the other language. | [optional] |
11
+ | **postal_code** | **String** | Postal code. | [optional] |
12
+ | **additional_number** | **String** | Additional number, used alongside the district to locate buildings within the Saudi addressing system. | [optional] |
13
+ | **unit_number** | **String** | Apartment or unit number. | [optional] |
14
+ | **location_coordinates** | **String** | Geographic coordinates of the registered address. Format: Two space-separated decimal numbers, longitude then latitude. | [optional] |
15
+ | **is_primary_address** | **Boolean** | Whether this address is the individual's primary registered address. | [optional] |
16
+ | **region_name** | **String** | Region name in the session locale. Arabic when the session locale is ar, and English when it is en. regionNameSecondary is the other language. | [optional] |
17
+ | **region_name_secondary** | **String** | Region name in the other language from regionName. English when the session locale is ar, and Arabic when it is en. | [optional] |
18
+ | **city_secondary** | **String** | City name in the other language from city. English when the session locale is ar, and Arabic when it is en. | [optional] |
19
+ | **street_secondary** | **String** | Street name in the other language from street. English when the session locale is ar, and Arabic when it is en. | [optional] |
20
+ | **district_secondary** | **String** | District name in the other language from district. English when the session locale is ar, and Arabic when it is en. | [optional] |
21
+ | **city_id** | **String** | City identifier. | [optional] |
22
+ | **region_id** | **String** | Region identifier. | [optional] |
23
+ | **district_id** | **String** | District identifier. | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'trinsic_api'
29
+
30
+ instance = TrinsicApi::SaudiArabiaNafathAddress.new(
31
+ building_number: 1234,
32
+ street: طريق الملك فهد,
33
+ district: العليا,
34
+ city: الرياض,
35
+ postal_code: 12345,
36
+ additional_number: 6789,
37
+ unit_number: 12B,
38
+ location_coordinates: 46.675296 24.713552,
39
+ is_primary_address: true,
40
+ region_name: منطقة الرياض,
41
+ region_name_secondary: Riyadh Region,
42
+ city_secondary: Riyadh,
43
+ street_secondary: King Fahd Road,
44
+ district_secondary: Al Olaya,
45
+ city_id: 101,
46
+ region_id: 01,
47
+ district_id: 402
48
+ )
49
+ ```
50
+
@@ -0,0 +1,68 @@
1
+ # TrinsicApi::SaudiArabiaNafathCitizenAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **arabic_first_name** | **String** | Given name in Arabic. Nafath always returns this in Arabic. romanizedFirstName is the English form, and the session locale does not change either name. | [optional] |
8
+ | **arabic_father_name** | **String** | Father's given name in Arabic. Same script as arabicFirstName. | [optional] |
9
+ | **arabic_grand_father_name** | **String** | Grandfather's given name in Arabic. Same script as arabicFirstName. | [optional] |
10
+ | **arabic_family_name** | **String** | Family name in Arabic. Same script as arabicFirstName. | [optional] |
11
+ | **romanized_first_name** | **String** | Given name in English. Nafath always returns this in English, including when the session locale is Arabic. | [optional] |
12
+ | **romanized_second_name** | **String** | Father's given name in English. Same script as romanizedFirstName. | [optional] |
13
+ | **romanized_third_name** | **String** | Grandfather's given name in English. Same script as romanizedFirstName. | [optional] |
14
+ | **romanized_last_name** | **String** | Family name in English. Same script as romanizedFirstName. | [optional] |
15
+ | **date_of_birth_hijri** | **String** | Date of birth in the Hijri (Umm al-Qura) calendar, in YYYY-MM-DD format. | [optional] |
16
+ | **id_issue_date_gregorian** | **Date** | Date the national ID card was issued in the Gregorian calendar. | [optional] |
17
+ | **id_issue_date_hijri** | **String** | Date the national ID card was issued in the Hijri calendar, in YYYY-MM-DD format. | [optional] |
18
+ | **id_expiry_date_gregorian** | **Date** | Date the national ID card expires in the Gregorian calendar. | [optional] |
19
+ | **id_expiry_date_hijri** | **String** | Date the national ID card expires in the Hijri calendar, in YYYY-MM-DD format. | [optional] |
20
+ | **id_version_number** | **String** | Version number printed on the national ID card. Represents the generation of national ID card this document was issued in. | [optional] |
21
+ | **id_issue_place** | **String** | City or office where the national ID card was issued, in Arabic. The session locale does not change it. | [optional] |
22
+ | **social_status_code** | **String** | Social-status (marital-status) code, from the Nafath socialStatusCode attribute. The numeric code is not unique on its own. The same code maps to different states depending on the value of the top-level sex field. Code by sex: - 0, M: Single - 1, F: Single - 1, M: One wife - 2, F: Married - 2, M: Two wives - 3, F: Divorced - 3, M: Three wives - 4, F: Widow - 4, M: Four wives - 5, F: Pending divorced Combinations not listed are not defined by Nafath. | [optional] |
23
+ | **social_status** | **String** | Social status description in Arabic, from the Nafath socialStatusDesc attribute. The session locale does not change it. socialStatusCode is the separate numeric code. | [optional] |
24
+ | **dependent_count** | **Integer** | Number of current dependents. | [optional] |
25
+ | **place_of_birth** | **String** | Place of birth in Arabic. The session locale does not change it. | [optional] |
26
+ | **last_travel_exit_date_gregorian** | **Date** | Most recent travel exit date in the Gregorian calendar. | [optional] |
27
+ | **last_travel_exit_date_hijri** | **String** | Most recent travel exit date in the Hijri calendar, in YYYY-MM-DD format. | [optional] |
28
+ | **last_travel_entry_date_gregorian** | **Date** | Most recent travel entry date in the Gregorian calendar. | [optional] |
29
+ | **last_travel_entry_date_hijri** | **String** | Most recent travel entry date in the Hijri calendar, in YYYY-MM-DD format. | [optional] |
30
+ | **is_minor** | **Boolean** | True when the citizen is a minor. | [optional] |
31
+ | **head_of_household** | [**SaudiArabiaNafathHeadOfHousehold**](SaudiArabiaNafathHeadOfHousehold.md) | Head of household information, intended for minor citizen workflows such as guardian consent for opening a bank account. The sandbox also returns it for adults, so it is included whenever present. | [optional] |
32
+ | **national_addresses** | [**Array<SaudiArabiaNafathAddress>**](SaudiArabiaNafathAddress.md) | Registered Saudi national addresses, as structured fields. Saudi Post (SPL) documents how to enter a national address on checkout and international forms: Line 1 is building number, unit number, and street name. Line 2 is the additional number and district. Then city and postal code. The country is always Saudi Arabia because Nafath only ever returns Saudi national addresses. https://splonline.com.sa/en/door-step/ | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'trinsic_api'
38
+
39
+ instance = TrinsicApi::SaudiArabiaNafathCitizenAttributes.new(
40
+ arabic_first_name: محمد,
41
+ arabic_father_name: عبدالله,
42
+ arabic_grand_father_name: سعود,
43
+ arabic_family_name: العتيبي,
44
+ romanized_first_name: Mohammed,
45
+ romanized_second_name: Abdullah,
46
+ romanized_third_name: Saud,
47
+ romanized_last_name: Alotaibi,
48
+ date_of_birth_hijri: 1407-06-12,
49
+ id_issue_date_gregorian: Wed Dec 29 00:00:00 UTC 2021,
50
+ id_issue_date_hijri: 1443-05-25,
51
+ id_expiry_date_gregorian: Mon Dec 29 00:00:00 UTC 2031,
52
+ id_expiry_date_hijri: 1453-05-25,
53
+ id_version_number: 4,
54
+ id_issue_place: الرياض,
55
+ social_status_code: 1,
56
+ social_status: متزوج,
57
+ dependent_count: 2,
58
+ place_of_birth: الرياض,
59
+ last_travel_exit_date_gregorian: Tue Jul 15 00:00:00 UTC 2025,
60
+ last_travel_exit_date_hijri: 1447-01-20,
61
+ last_travel_entry_date_gregorian: Fri Aug 01 00:00:00 UTC 2025,
62
+ last_travel_entry_date_hijri: 1447-02-07,
63
+ is_minor: false,
64
+ head_of_household: null,
65
+ national_addresses: [{"buildingNumber":"1234","street":"طريق الملك فهد","district":"العليا","city":"الرياض","postalCode":"12345","additionalNumber":"6789","unitNumber":"12B","locationCoordinates":"46.675296 24.713552","isPrimaryAddress":true,"regionName":"منطقة الرياض","regionNameSecondary":"Riyadh Region","citySecondary":"Riyadh","streetSecondary":"King Fahd Road","districtSecondary":"Al Olaya","cityId":"101","regionId":"01","districtId":"402"}]
66
+ )
67
+ ```
68
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::SaudiArabiaNafathHeadOfHousehold
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_identity_number** | **String** | Head of household national identity number. | [optional] |
8
+ | **arabic_first_name** | **String** | Head of household given name in Arabic. | [optional] |
9
+ | **arabic_father_name** | **String** | Head of household father name in Arabic. | [optional] |
10
+ | **arabic_grand_father_name** | **String** | Head of household grandfather name in Arabic. | [optional] |
11
+ | **arabic_family_name** | **String** | Head of household family name in Arabic. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::SaudiArabiaNafathHeadOfHousehold.new(
19
+ national_identity_number: 1023456789,
20
+ arabic_first_name: عبدالرحمن,
21
+ arabic_father_name: سعد,
22
+ arabic_grand_father_name: محمد,
23
+ arabic_family_name: القحطاني
24
+ )
25
+ ```
26
+
@@ -0,0 +1,38 @@
1
+ # TrinsicApi::SaudiArabiaNafathProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_identity_number** | **String** | Saudi Arabia national identity number used to authenticate the individual with Nafath. Nafath supports three user types and the leading digit of this number identifies which one signed in: - 1: Saudi citizen national ID, issued by Civil Affairs (Al-Ahwal al-Madaniyya) under the Ministry of Interior. - 2: Resident (Iqama or muqeem) number on the residence permit, issued by the General Directorate of Passports (Al-Jawazat) under the Ministry of Interior. - 3 through 6: Visitor identity number (Hawiyyat Za'ir) for foreign nationals admitted on short-term visas, including tourist, business, family visit, and Umrah visas. Format: - Exactly ten decimal digits. - First digit is the user type as listed above. - Digits two through nine are assigned serially and have no semantic meaning. - For citizen and resident numbers, the tenth digit is a check digit derived from the first nine digits with a modulus-ten style algorithm. No check digit is documented for visitor numbers, and the Nafath sandbox's visitor numbers do not follow it. Nafath returns no identifier for visitors, so for them this is the number the user submitted. | [optional] |
8
+ | **user_type** | **String** | Nafath user type derived from the leading digit of nationalIdentityNumber. The matching attributes object carries the fields Nafath defines only for that user type. Possible values: - Citizen: Saudi citizen national ID (1-series). See citizenSpecificAttributes. - Resident: legally resident foreign national, Iqama (2-series). See residentSpecificAttributes. - Visitor: visitor identity (3 through 6-series). See visitorSpecificAttributes. | [optional] |
9
+ | **sex** | **String** | Sex as returned by Nafath, normalized to the platform sex code. Possible values: - Male - Female | [optional] |
10
+ | **nationality** | **String** | Nationality as an ISO 3166-1 alpha-2 country code. Not every nationality passed by back Nafath corresponds to an ISO 3166-1 alpha-2 code, for example code 335 (Tribes Emigrated) or 336 (Turkestan). In these cases, this field is null. See nationalityCode for the raw nationality code. | [optional] |
11
+ | **nationality_code** | **String** | Nationality code as returned by Nafath under nationalityCode. This is the Saudi government's three-digit nationality code, grouped by region: - 1xx Arab states - 2xx North Africa - 3xx Asia, Middle East, and Oceania - 4xx Sub-Saharan Africa - 5xx Europe - 6xx Americas - 7xx Oceania It is not an ISO 3166 numeric code. For example, 504 is Ireland according to Nafath but Morocco in ISO 3166. See https://docs.trinsic.id/docs/saudi-arabia-nafath for a full list. | [optional] |
12
+ | **date_of_birth_gregorian** | **Date** | Date of birth in the Gregorian calendar. | [optional] |
13
+ | **occupation_code** | **String** | Occupation code reported by Nafath. Known values: - O: Other - G: Government | [optional] |
14
+ | **passport_number** | **String** | Passport number reported by Nafath. | [optional] |
15
+ | **citizen_specific_attributes** | [**SaudiArabiaNafathCitizenAttributes**](SaudiArabiaNafathCitizenAttributes.md) | Attributes Nafath defines only for Saudi citizens. Present only when userType is Citizen. | [optional] |
16
+ | **resident_specific_attributes** | [**SaudiArabiaNafathResidentAttributes**](SaudiArabiaNafathResidentAttributes.md) | Attributes Nafath defines only for residents holding an Iqama. Present only when userType is Resident. | [optional] |
17
+ | **visitor_specific_attributes** | [**SaudiArabiaNafathVisitorAttributes**](SaudiArabiaNafathVisitorAttributes.md) | Attributes Nafath defines only for visitors on short-term visas. Present only when userType is Visitor. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'trinsic_api'
23
+
24
+ instance = TrinsicApi::SaudiArabiaNafathProviderOutput.new(
25
+ national_identity_number: 1035771078,
26
+ user_type: Citizen,
27
+ sex: Male,
28
+ nationality: SA,
29
+ nationality_code: 113,
30
+ date_of_birth_gregorian: Tue Feb 10 00:00:00 UTC 1987,
31
+ occupation_code: G,
32
+ passport_number: X55448,
33
+ citizen_specific_attributes: null,
34
+ resident_specific_attributes: null,
35
+ visitor_specific_attributes: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,68 @@
1
+ # TrinsicApi::SaudiArabiaNafathResidentAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **arabic_first_name** | **String** | Given name in Arabic. Nafath always returns this in Arabic. romanizedFirstName is the English form, and the session locale does not change either name. | [optional] |
8
+ | **arabic_second_name** | **String** | Second name in Arabic. Same script as arabicFirstName. | [optional] |
9
+ | **arabic_third_name** | **String** | Third name in Arabic. Same script as arabicFirstName. | [optional] |
10
+ | **arabic_last_name** | **String** | Last name in Arabic. Same script as arabicFirstName. | [optional] |
11
+ | **romanized_first_name** | **String** | Given name in English. Nafath always returns this in English, including when the session locale is Arabic. | [optional] |
12
+ | **romanized_second_name** | **String** | Second name in English. Same script as romanizedFirstName. | [optional] |
13
+ | **romanized_third_name** | **String** | Third name in English. Same script as romanizedFirstName. | [optional] |
14
+ | **romanized_last_name** | **String** | Last name in English. Same script as romanizedFirstName. | [optional] |
15
+ | **nationality_description** | **String** | English nationality name. | [optional] |
16
+ | **date_of_birth_hijri** | **String** | Date of birth in the Hijri (Umm al-Qura) calendar, in YYYY-MM-DD format. | [optional] |
17
+ | **iqama_issue_date_gregorian** | **Date** | Date the Iqama was issued in the Gregorian calendar. | [optional] |
18
+ | **iqama_issue_date_hijri** | **String** | Date the Iqama was issued in the Hijri calendar, in YYYY-MM-DD format. | [optional] |
19
+ | **iqama_expiry_date_gregorian** | **Date** | Date the Iqama expires in the Gregorian calendar. | [optional] |
20
+ | **iqama_expiry_date_hijri** | **String** | Date the Iqama expires in the Hijri calendar, in YYYY-MM-DD format. | [optional] |
21
+ | **iqama_version_number** | **String** | Version number printed on the Iqama. Represents the Iqama permit generation version. | [optional] |
22
+ | **iqama_issue_place** | **String** | Name of the city or office that issued the Iqama, in Arabic. The session locale does not change it. | [optional] |
23
+ | **iqama_issue_place_code** | **String** | Code for the office that issued the Iqama. | [optional] |
24
+ | **occupation_description** | **String** | Free-text occupation description. | [optional] |
25
+ | **social_status_code** | **String** | Social-status (marital-status) code, from the Nafath socialStatusCode attribute. The numeric code is not unique on its own. The same code maps to different states depending on the value of the top-level sex field. Code by sex: - 0, M: Single - 1, F: Single - 1, M: One wife - 2, F: Married - 2, M: Two wives - 3, F: Divorced - 3, M: Three wives - 4, F: Widow - 4, M: Four wives - 5, F: Pending divorced Combinations not listed are not defined by Nafath. | [optional] |
26
+ | **social_status** | **String** | Social status in uppercase English, for example MARRIED, from the Nafath socialStatus attribute. Possible English values include: Single, Married, Divorced, Widow, Pending Divorced, One Wife, Two Wives, Three Wives, Four Wives. | [optional] |
27
+ | **place_of_birth** | **String** | Place of birth name. | [optional] |
28
+ | **place_of_birth_code** | **String** | Code for the place of birth. | [optional] |
29
+ | **sponsor_name** | **String** | Name of the entity sponsoring the Iqama, typically an employer. | [optional] |
30
+ | **legal_status** | **String** | Legal status. | [optional] |
31
+ | **in_out_indicator** | **String** | Whether the resident is currently inside or outside Saudi Arabia based on their last recorded travel event. Possible values include: - IN: most recent travel event was an entry into Saudi Arabia. - OUT: most recent travel event was an exit from Saudi Arabia. | [optional] |
32
+ | **national_addresses** | [**Array<SaudiArabiaNafathAddress>**](SaudiArabiaNafathAddress.md) | Registered Saudi national addresses. Saudi Post (SPL) documents how to enter a national address on checkout and international forms: Line 1 is building number, unit number, and street name. Line 2 is the additional number and district. Then city and postal code. The country is always Saudi Arabia. https://splonline.com.sa/en/door-step/ | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'trinsic_api'
38
+
39
+ instance = TrinsicApi::SaudiArabiaNafathResidentAttributes.new(
40
+ arabic_first_name: أحمد,
41
+ arabic_second_name: خالد,
42
+ arabic_third_name: رحمن,
43
+ arabic_last_name: الأنصاري,
44
+ romanized_first_name: Ahmed,
45
+ romanized_second_name: Khalid,
46
+ romanized_third_name: Rahman,
47
+ romanized_last_name: Ansari,
48
+ nationality_description: India,
49
+ date_of_birth_hijri: 1408-12-15,
50
+ iqama_issue_date_gregorian: Sun May 15 00:00:00 UTC 2022,
51
+ iqama_issue_date_hijri: 1443-10-14,
52
+ iqama_expiry_date_gregorian: Fri May 14 00:00:00 UTC 2027,
53
+ iqama_expiry_date_hijri: 1448-11-08,
54
+ iqama_version_number: 4,
55
+ iqama_issue_place: الرياض,
56
+ iqama_issue_place_code: 1,
57
+ occupation_description: Software Engineer,
58
+ social_status_code: 1,
59
+ social_status: MARRIED,
60
+ place_of_birth: Mumbai,
61
+ place_of_birth_code: MUM,
62
+ sponsor_name: Acme Trading LLC,
63
+ legal_status: Resident,
64
+ in_out_indicator: IN,
65
+ national_addresses: [{"buildingNumber":"55","street":"شارع التوبة","district":"العليا","city":"الرياض","postalCode":"12214","additionalNumber":"3030","unitNumber":"12A","locationCoordinates":"46.675296 24.713552","isPrimaryAddress":true,"regionName":"منطقة الرياض","regionNameSecondary":"Riyadh Region","citySecondary":"Riyadh","streetSecondary":"At Tawbah","districtSecondary":"Al Olaya","cityId":"101","regionId":"01","districtId":"402"}]
66
+ )
67
+ ```
68
+
@@ -0,0 +1,72 @@
1
+ # TrinsicApi::SaudiArabiaNafathVisitorAttributes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **login_type** | **String** | Credential the visitor used to log in to Nafath. Possible values: - VisaNumber: the visitor authenticated with the visa number printed on their visa document. - BorderNumber: the visitor authenticated with their border number (raqam al-hudud), the ten-digit identifier the General Directorate of Passports (Jawazat) assigns to a foreign national on entry into Saudi Arabia, used as their entry-linked identifier before any residency is issued. | [optional] |
8
+ | **first_name** | **String** | First name in English. Nafath describes firstName, secondName, thirdName, and lastName as English. translatedFirstName is the Arabic form. The session locale does not change either name. | [optional] |
9
+ | **second_name** | **String** | Second name in English. Same script as firstName. | [optional] |
10
+ | **third_name** | **String** | Third name, from the Nafath thirdName attribute. See firstName for the script. | [optional] |
11
+ | **last_name** | **String** | Last name, from the Nafath lastName attribute. See firstName for the script. | [optional] |
12
+ | **translated_first_name** | **String** | First name in Arabic, from the Nafath translatedFirstName attribute. Nafath's descriptions of firstName, secondName, thirdName, and lastName call those fields English, so the translated names are treated as Arabic for both visa-number and border-number logins. The session locale does not change either script. | [optional] |
13
+ | **translated_second_name** | **String** | Second name in Arabic. Same script as translatedFirstName. | [optional] |
14
+ | **translated_third_name** | **String** | Third name in Arabic. Same script as translatedFirstName. | [optional] |
15
+ | **translated_last_name** | **String** | Last name in Arabic. Same script as translatedFirstName. | [optional] |
16
+ | **nationality_description** | **String** | English nationality name, from the Nafath nationalityDesc attribute. | [optional] |
17
+ | **date_of_birth_hijri** | **String** | Date of birth in the Hijri (Umm al-Qura) calendar, in YYYY-MM-DD format, from the Nafath birthhDate attribute. Only returned for visa-number logins; the appendix defines no Hijri date of birth for border-number logins. Nafath's examples also use DD-MM-YYYY and YYYY/MM/DD; Trinsic reorders those to YYYY-MM-DD and passes any other format through unchanged. | [optional] |
18
+ | **visa_number** | **String** | Visa number, from the Nafath visaNumber attribute. Can contain letters as well as digits. | [optional] |
19
+ | **visa_duration_days** | **Integer** | Count of days from visa issue to visa expiry, parsed from the Nafath duration attribute. Null when duration is absent or not a valid integer. | [optional] |
20
+ | **visa_issue_date** | **Date** | Date the visa was issued, from the Nafath visaIssueDate attribute. | [optional] |
21
+ | **visa_expiry_date** | **Date** | Final date the visitor is permitted to enter Saudi Arabia, from the Nafath visaExpiryDate attribute. | [optional] |
22
+ | **final_departure_date** | **Date** | Last day the visitor may legally remain in Saudi Arabia, from the Nafath finalDepartureDate attribute. | [optional] |
23
+ | **number_of_entries_code** | **String** | Number-of-entries code, from the Nafath numberOfEntriesCode attribute. Known values: - 1: Single entry - 9: Multiple entry | [optional] |
24
+ | **number_of_entries_description_arabic** | **String** | Arabic description of the entries the visa allows, from the Nafath numberOfEntriesDescAr attribute. | [optional] |
25
+ | **visa_type_code** | **String** | Visa type code, from the Nafath visaTypeCode attribute. The appendix publishes no lookup table; the sandbox returns BUS for a business visit visa. | [optional] |
26
+ | **visa_type_description_arabic** | **String** | Arabic visa type description, from the Nafath visaTypeDescAr attribute. | [optional] |
27
+ | **visa_type_description_english** | **String** | English visa type description, from the Nafath visaTypeDescEn attribute. | [optional] |
28
+ | **passport_issue_date** | **Date** | Date the visitor's passport was issued, from the Nafath passportIssueDate attribute. | [optional] |
29
+ | **passport_expiry_date** | **Date** | Date the visitor's passport expires, from the Nafath passportExpiryDate attribute. | [optional] |
30
+ | **occupation_description_arabic** | **String** | Arabic occupation description, from the Nafath occupationDescAr attribute. | [optional] |
31
+ | **occupation_description_english** | **String** | English occupation description, from the Nafath occupationDescEn attribute. | [optional] |
32
+ | **birth_country_arabic** | **String** | Arabic name of the visitor's birth country, from the Nafath birthCountryDescAr attribute. | [optional] |
33
+ | **birth_country_english** | **String** | English name of the visitor's birth country, from the Nafath birthCountryDescEn attribute. | [optional] |
34
+ | **entry_date** | **Date** | Date the visitor entered Saudi Arabia, from the Nafath entryDate attribute. Only returned for border-number logins. | [optional] |
35
+
36
+ ## Example
37
+
38
+ ```ruby
39
+ require 'trinsic_api'
40
+
41
+ instance = TrinsicApi::SaudiArabiaNafathVisitorAttributes.new(
42
+ login_type: VisaNumber,
43
+ first_name: Fatima,
44
+ second_name: Ali,
45
+ third_name: Hassan,
46
+ last_name: Mohammed,
47
+ translated_first_name: فاطمة,
48
+ translated_second_name: علي,
49
+ translated_third_name: حسن,
50
+ translated_last_name: محمد,
51
+ nationality_description: Egypt,
52
+ date_of_birth_hijri: 1412-08-21,
53
+ visa_number: V20251234567,
54
+ visa_duration_days: 90,
55
+ visa_issue_date: Wed Jan 15 00:00:00 UTC 2025,
56
+ visa_expiry_date: Tue Apr 15 00:00:00 UTC 2025,
57
+ final_departure_date: Thu May 01 00:00:00 UTC 2025,
58
+ number_of_entries_code: 1,
59
+ number_of_entries_description_arabic: دخول واحد,
60
+ visa_type_code: BUS,
61
+ visa_type_description_arabic: تأشيرة زيارة أعمال,
62
+ visa_type_description_english: Business Visit,
63
+ passport_issue_date: Mon Apr 10 00:00:00 UTC 2023,
64
+ passport_expiry_date: Sat Apr 09 00:00:00 UTC 2033,
65
+ occupation_description_arabic: مهندس,
66
+ occupation_description_english: Engineer,
67
+ birth_country_arabic: مصر,
68
+ birth_country_english: Egypt,
69
+ entry_date: Sat Feb 01 00:00:00 UTC 2025
70
+ )
71
+ ```
72
+
data/docs/SessionsApi.md CHANGED
@@ -107,7 +107,7 @@ end
107
107
 
108
108
  api_instance = TrinsicApi::SessionsApi.new
109
109
  opts = {
110
- create_direct_provider_session_request: TrinsicApi::CreateDirectProviderSessionRequest.new({provider: 'provider_example', verification_profile_id: 'verification_profile_id_example', capabilities: [TrinsicApi::IntegrationCapability::LAUNCH_BROWSER]}) # CreateDirectProviderSessionRequest |
110
+ create_direct_provider_session_request: TrinsicApi::CreateDirectProviderSessionRequest.new({provider: 'provider_example', verification_profile_id: 'verification_profile_id_example', enable_redirect_backwards_compatibility: false, capabilities: [TrinsicApi::IntegrationCapability::LAUNCH_BROWSER]}) # CreateDirectProviderSessionRequest |
111
111
  }
112
112
 
113
113
  begin
@@ -178,7 +178,7 @@ end
178
178
 
179
179
  api_instance = TrinsicApi::SessionsApi.new
180
180
  opts = {
181
- create_hosted_provider_session_request: TrinsicApi::CreateHostedProviderSessionRequest.new({provider: 'provider_example', verification_profile_id: 'verification_profile_id_example', redirect_url: 'redirect_url_example'}) # CreateHostedProviderSessionRequest |
181
+ create_hosted_provider_session_request: TrinsicApi::CreateHostedProviderSessionRequest.new({provider: 'provider_example', verification_profile_id: 'verification_profile_id_example', redirect_url: 'redirect_url_example', enable_redirect_backwards_compatibility: false}) # CreateHostedProviderSessionRequest |
182
182
  }
183
183
 
184
184
  begin
@@ -10,7 +10,7 @@
10
10
  | **aadhaar_number_last_four** | **String** | The Aadhaar number (UID) value for the individual. This is only the last four digits of the Aadhaar number. | [optional] |
11
11
  | **claims** | [**AadhaarClaims**](AadhaarClaims.md) | The claims extracted from the Aadhaar document. | [optional] |
12
12
  | **localized_claims** | [**AadhaarLocalizedClaims**](AadhaarLocalizedClaims.md) | The localized claims extracted from the Aadhaar document. | [optional] |
13
- | **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded. When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation. | [optional] |
13
+ | **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded. When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation. | [optional] |
14
14
  | **digilocker_id** | **String** | DigiLocker's 36-character stable account identifier. This identifier is deemed safe to use to reference the individual. *Note, the format is not guaranteed to be a UUID. | [optional] |
15
15
  | **issuer_id** | **String** | The identifier for the issuer of the DigiLocker document. | [optional] |
16
16
  | **issuer** | **String** | Issuer name for the DigiLocker document. | [optional] |
@@ -25,7 +25,7 @@
25
25
  | **pass_expiry_date** | **Date** | Pass expiration date. Note that this only applies to a FIN holder. | [optional] |
26
26
  | **employment_sector** | **String** | The user's employment sector. | [optional] |
27
27
  | **registered_address** | [**SingpassMyInfoRegisteredAddressOutput**](SingpassMyInfoRegisteredAddressOutput.md) | The user's registered address. | [optional] |
28
- | **house_developmenet_board_type** | [**SingpassMyInfoDescription**](SingpassMyInfoDescription.md) | Housing and Development Board (HBD) flat type code and description. This value will be null if not HBD Possible values (code description): - 111 1-ROOM FLAT (HDB) - 112 2-ROOM FLAT (HDB) - 113 3-ROOM FLAT (HDB) - 114 4-ROOM FLAT (HDB) - 115 5-ROOM FLAT (HDB) - 116 EXECUTIVE FLAT (HDB) - 118 STUDIO APARTMENT (HDB) | [optional] |
28
+ | **house_development_board_type** | [**SingpassMyInfoDescription**](SingpassMyInfoDescription.md) | Housing and Development Board (HDB) flat type code and description. This value will be null if not HDB. Possible values (code description): - 111 1-ROOM FLAT (HDB) - 112 2-ROOM FLAT (HDB) - 113 3-ROOM FLAT (HDB) - 114 4-ROOM FLAT (HDB) - 115 5-ROOM FLAT (HDB) - 116 EXECUTIVE FLAT (HDB) - 118 STUDIO APARTMENT (HDB) | [optional] |
29
29
  | **housing_type** | [**SingpassMyInfoDescription**](SingpassMyInfoDescription.md) | The user's housing type. Possible values (code description): - 121 DETACHED HOUSE - 122 SEMI-DETACHED HOUSE - 123 TERRACE HOUSE - 131 CONDOMINIUM - 132 EXECUTIVE CONDOMINIUM - 139 APARTMENT | [optional] |
30
30
  | **sex** | **String** | Sex of the individual. Possible values: - Female - Male - Unknown | [optional] |
31
31
 
@@ -56,7 +56,7 @@ instance = TrinsicApi::SingpassPersonalCatalog.new(
56
56
  pass_expiry_date: Tue Dec 31 00:00:00 UTC 2030,
57
57
  employment_sector: Technology,
58
58
  registered_address: null,
59
- house_developmenet_board_type: null,
59
+ house_development_board_type: null,
60
60
  housing_type: null,
61
61
  sex: Female
62
62
  )
@@ -5,7 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **full_name** | **String** | The full name of the individual. | [optional] |
8
- | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
8
+ | **date_of_birth** | **Date** | The individual's date of birth in YYYY-MM-DD format. | [optional] |
9
+ | **sex** | **String** | The individual's sex, derived from the personal identity number. Values are Male or Female. | [optional] |
10
+ | **sub** | **String** | The OpenID Connect sub claim, when returned in the provider response. The value starts with the se_bankid: prefix followed by the subject identifier. | [optional] |
9
11
  | **personal_identity_number** | **String** | The Swedish personal number (personnummer) associated with the verified individual. The value is typically a 12-digit number. This is in the format YYYYMMDDXXXX, where: - YYYYMMDD is the date of birth. - XXXX is an individual number, indicating gender. If XXXX is even, the individual is female. If XXXX is odd, the individual is male. | [optional] |
10
12
  | **given_name** | **String** | The given name of the individual | [optional] |
11
13
  | **family_name** | **String** | The family name of the individual | [optional] |
@@ -25,8 +27,10 @@ require 'trinsic_api'
25
27
 
26
28
  instance = TrinsicApi::SwedenBankIdProviderOutput.new(
27
29
  full_name: Ove Henriksen,
28
- date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
29
- personal_identity_number: 20200101-1231,
30
+ date_of_birth: Fri Apr 12 00:00:00 UTC 1985,
31
+ sex: Male,
32
+ sub: se_bankid:8f27c1a6-5d93-4eb0-a762-3c9016d4b8ef,
33
+ personal_identity_number: 202001011234,
30
34
  given_name: Ove,
31
35
  family_name: Henriksen,
32
36
  country: SE,