trinsic_api 3.1.0 → 3.2.0

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 (215) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AppleWalletDigitalIdBirthDate.md +20 -0
  3. data/docs/AppleWalletDigitalIdCredential.md +54 -0
  4. data/docs/AppleWalletProviderOutput.md +2 -0
  5. data/docs/BrazilCnhFacialBiometryOutput.md +24 -0
  6. data/docs/BrazilCnhMatchFieldDateOnly.md +20 -0
  7. data/docs/BrazilCnhMatchFieldString.md +20 -0
  8. data/docs/BrazilCnhProviderOutput.md +48 -0
  9. data/docs/CreateDirectProviderSessionRequest.md +1 -1
  10. data/docs/CreateHostedProviderSessionRequest.md +1 -1
  11. data/docs/CzechBankIdAddress.md +36 -0
  12. data/docs/CzechBankIdCard.md +30 -0
  13. data/docs/CzechBankIdProviderOutput.md +78 -0
  14. data/docs/CzechBankIdTitle.md +20 -0
  15. data/docs/CzechBankIdVerification.md +22 -0
  16. data/docs/DiiaIssuerOutput.md +28 -0
  17. data/docs/DiiaProviderOutput.md +20 -0
  18. data/docs/DiiaSubjectOutput.md +26 -0
  19. data/docs/IdemiaPreviewProviderAddress.md +32 -0
  20. data/docs/IdemiaPreviewProviderOutput.md +76 -0
  21. data/docs/IndiaDigilockerAadhaarMatchDateOfBirthField.md +20 -0
  22. data/docs/IndiaDigilockerAadhaarMatchFullNameField.md +20 -0
  23. data/docs/IndiaDigilockerAadhaarMatchProviderOutput.md +20 -0
  24. data/docs/IndonesiaDukcapilMatchDateOfBirthField.md +20 -0
  25. data/docs/IndonesiaDukcapilMatchFullNameField.md +20 -0
  26. data/docs/IndonesiaDukcapilMatchNationalIdNumberField.md +20 -0
  27. data/docs/IndonesiaDukcapilMatchProviderOutput.md +38 -0
  28. data/docs/IndonesiaNikMatch.md +34 -0
  29. data/docs/IndonesiaNikMatchField.md +20 -0
  30. data/docs/InteracAddress.md +26 -0
  31. data/docs/InteracProviderOutput.md +34 -0
  32. data/docs/ItsmeAddress.md +28 -0
  33. data/docs/ItsmeProviderOutput.md +19 -1
  34. data/docs/KenyaNidMatch2DateOfBirthField.md +20 -0
  35. data/docs/KenyaNidMatch2FullNameField.md +20 -0
  36. data/docs/KenyaNidMatch2NationalIdNumberField.md +20 -0
  37. data/docs/KenyaNidMatch2ProviderOutput.md +24 -0
  38. data/docs/KenyaNidMatch2SexField.md +20 -0
  39. data/docs/LloydsSmartIdProviderOutput.md +2 -2
  40. data/docs/MexicoCurpProviderOutput.md +23 -1
  41. data/docs/NigeriaNinLookup2Input.md +1 -1
  42. data/docs/NigeriaNinLookup2ProviderOutput.md +2 -2
  43. data/docs/NigeriaNinMatch2DateOfBirthField.md +20 -0
  44. data/docs/NigeriaNinMatch2FullNameField.md +20 -0
  45. data/docs/NigeriaNinMatch2Input.md +1 -1
  46. data/docs/NigeriaNinMatch2NationalIdNumberField.md +20 -0
  47. data/docs/NigeriaNinMatch2PhoneNumberField.md +20 -0
  48. data/docs/NigeriaNinMatch2ProviderOutput.md +26 -0
  49. data/docs/NigeriaNinMatch2SexField.md +20 -0
  50. data/docs/PhilippinesPhilsysMatchProviderOutput.md +26 -0
  51. data/docs/PostOfficeEasyIdProviderOutput.md +2 -2
  52. data/docs/ProviderInput.md +0 -6
  53. data/docs/ProviderOutput.md +37 -3
  54. data/docs/SouthAfricaNidLookup2Input.md +1 -1
  55. data/docs/SouthAfricaNidLookup2ProviderOutput.md +36 -0
  56. data/docs/SouthAfricaNidMatch2DateOfBirthField.md +20 -0
  57. data/docs/SouthAfricaNidMatch2FullNameField.md +20 -0
  58. data/docs/SouthAfricaNidMatch2Input.md +2 -4
  59. data/docs/SouthAfricaNidMatch2NationalIdNumberField.md +20 -0
  60. data/docs/SouthAfricaNidMatch2ProviderOutput.md +26 -0
  61. data/docs/SouthAfricaNidMatch2SexField.md +20 -0
  62. data/docs/UAEPassProviderOutput.md +62 -0
  63. data/docs/UgandaNidMatch2DateOfBirthField.md +20 -0
  64. data/docs/UgandaNidMatch2Input.md +1 -1
  65. data/docs/UgandaNidMatch2NationalIdNumberField.md +20 -0
  66. data/docs/UgandaNidMatch2ProviderOutput.md +22 -0
  67. data/docs/UgandaNidMatch2SecondaryIdNumberField.md +20 -0
  68. data/docs/VerimiAddressOutput.md +28 -0
  69. data/docs/VerimiProviderOutput.md +68 -0
  70. data/docs/YotiDeeplinkProviderOutput.md +2 -2
  71. data/docs/YotiProviderOutput.md +2 -2
  72. data/docs/ZimbabweNidLookup2Input.md +1 -1
  73. data/docs/ZimbabweNidLookup2ProviderOutput.md +34 -0
  74. data/lib/trinsic_api/models/apple_wallet_digital_id_birth_date.rb +177 -0
  75. data/lib/trinsic_api/models/apple_wallet_digital_id_credential.rb +350 -0
  76. data/lib/trinsic_api/models/apple_wallet_provider_output.rb +12 -1
  77. data/lib/trinsic_api/models/brazil_cnh_facial_biometry_output.rb +198 -0
  78. data/lib/trinsic_api/models/{south_africa_nid_biometric2_input.rb → brazil_cnh_match_field_date_only.rb} +36 -33
  79. data/lib/trinsic_api/models/{nigeria_nin_biometric2_input.rb → brazil_cnh_match_field_string.rb} +20 -33
  80. data/lib/trinsic_api/models/brazil_cnh_provider_output.rb +315 -0
  81. data/lib/trinsic_api/models/create_direct_provider_session_request.rb +1 -1
  82. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +1 -1
  83. data/lib/trinsic_api/models/czech_bank_id_address.rb +296 -0
  84. data/lib/trinsic_api/models/czech_bank_id_card.rb +279 -0
  85. data/lib/trinsic_api/models/czech_bank_id_provider_output.rb +504 -0
  86. data/lib/trinsic_api/models/czech_bank_id_title.rb +160 -0
  87. data/lib/trinsic_api/models/czech_bank_id_verification.rb +203 -0
  88. data/lib/trinsic_api/models/diia_issuer_output.rb +204 -0
  89. data/lib/trinsic_api/models/diia_provider_output.rb +193 -0
  90. data/lib/trinsic_api/models/diia_subject_output.rb +193 -0
  91. data/lib/trinsic_api/models/idemia_preview_provider_address.rb +226 -0
  92. data/lib/trinsic_api/models/idemia_preview_provider_output.rb +469 -0
  93. data/lib/trinsic_api/models/india_digilocker_aadhaar_match_date_of_birth_field.rb +192 -0
  94. data/lib/trinsic_api/models/india_digilocker_aadhaar_match_full_name_field.rb +192 -0
  95. data/lib/trinsic_api/models/india_digilocker_aadhaar_match_provider_output.rb +161 -0
  96. data/lib/trinsic_api/models/indonesia_dukcapil_match_date_of_birth_field.rb +192 -0
  97. data/lib/trinsic_api/models/indonesia_dukcapil_match_full_name_field.rb +192 -0
  98. data/lib/trinsic_api/models/indonesia_dukcapil_match_national_id_number_field.rb +192 -0
  99. data/lib/trinsic_api/models/indonesia_dukcapil_match_provider_output.rb +404 -0
  100. data/lib/trinsic_api/models/indonesia_nik_match.rb +238 -0
  101. data/lib/trinsic_api/models/indonesia_nik_match_field.rb +192 -0
  102. data/lib/trinsic_api/models/{kenya_nid_biometric2_input.rb → interac_address.rb} +50 -30
  103. data/lib/trinsic_api/models/interac_provider_output.rb +237 -0
  104. data/lib/trinsic_api/models/itsme_address.rb +204 -0
  105. data/lib/trinsic_api/models/itsme_provider_output.rb +104 -5
  106. data/lib/trinsic_api/models/kenya_nid_match2_date_of_birth_field.rb +192 -0
  107. data/lib/trinsic_api/models/kenya_nid_match2_full_name_field.rb +192 -0
  108. data/lib/trinsic_api/models/kenya_nid_match2_national_id_number_field.rb +192 -0
  109. data/lib/trinsic_api/models/kenya_nid_match2_provider_output.rb +215 -0
  110. data/lib/trinsic_api/models/kenya_nid_match2_sex_field.rb +192 -0
  111. data/lib/trinsic_api/models/lloyds_smart_id_provider_output.rb +8 -8
  112. data/lib/trinsic_api/models/mexico_curp_provider_output.rb +126 -5
  113. data/lib/trinsic_api/models/nigeria_nin_lookup2_input.rb +1 -1
  114. data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb +1 -1
  115. data/lib/trinsic_api/models/nigeria_nin_match2_date_of_birth_field.rb +192 -0
  116. data/lib/trinsic_api/models/nigeria_nin_match2_full_name_field.rb +192 -0
  117. data/lib/trinsic_api/models/nigeria_nin_match2_input.rb +1 -1
  118. data/lib/trinsic_api/models/nigeria_nin_match2_national_id_number_field.rb +192 -0
  119. data/lib/trinsic_api/models/nigeria_nin_match2_phone_number_field.rb +192 -0
  120. data/lib/trinsic_api/models/nigeria_nin_match2_provider_output.rb +226 -0
  121. data/lib/trinsic_api/models/nigeria_nin_match2_sex_field.rb +192 -0
  122. data/lib/trinsic_api/models/philippines_philsys_match_provider_output.rb +226 -0
  123. data/lib/trinsic_api/models/post_office_easy_id_provider_output.rb +8 -8
  124. data/lib/trinsic_api/models/provider_input.rb +1 -34
  125. data/lib/trinsic_api/models/provider_output.rb +203 -16
  126. data/lib/trinsic_api/models/south_africa_nid_lookup2_input.rb +1 -1
  127. data/lib/trinsic_api/models/south_africa_nid_lookup2_provider_output.rb +377 -0
  128. data/lib/trinsic_api/models/south_africa_nid_match2_date_of_birth_field.rb +192 -0
  129. data/lib/trinsic_api/models/south_africa_nid_match2_full_name_field.rb +192 -0
  130. data/lib/trinsic_api/models/south_africa_nid_match2_input.rb +6 -17
  131. data/lib/trinsic_api/models/south_africa_nid_match2_national_id_number_field.rb +192 -0
  132. data/lib/trinsic_api/models/south_africa_nid_match2_provider_output.rb +226 -0
  133. data/lib/trinsic_api/models/south_africa_nid_match2_sex_field.rb +192 -0
  134. data/lib/trinsic_api/models/uae_pass_provider_output.rb +394 -0
  135. data/lib/trinsic_api/models/uganda_nid_match2_date_of_birth_field.rb +192 -0
  136. data/lib/trinsic_api/models/uganda_nid_match2_input.rb +1 -1
  137. data/lib/trinsic_api/models/uganda_nid_match2_national_id_number_field.rb +192 -0
  138. data/lib/trinsic_api/models/uganda_nid_match2_provider_output.rb +220 -0
  139. data/lib/trinsic_api/models/uganda_nid_match2_secondary_id_number_field.rb +192 -0
  140. data/lib/trinsic_api/models/verimi_address_output.rb +204 -0
  141. data/lib/trinsic_api/models/verimi_provider_output.rb +425 -0
  142. data/lib/trinsic_api/models/yoti_deeplink_provider_output.rb +8 -8
  143. data/lib/trinsic_api/models/yoti_provider_output.rb +8 -8
  144. data/lib/trinsic_api/models/zimbabwe_nid_lookup2_input.rb +1 -1
  145. data/lib/trinsic_api/models/zimbabwe_nid_lookup2_provider_output.rb +334 -0
  146. data/lib/trinsic_api/version.rb +1 -1
  147. data/lib/trinsic_api.rb +54 -3
  148. data/spec/models/apple_wallet_digital_id_birth_date_spec.rb +42 -0
  149. data/spec/models/apple_wallet_digital_id_credential_spec.rb +144 -0
  150. data/spec/models/apple_wallet_provider_output_spec.rb +6 -0
  151. data/spec/models/brazil_cnh_facial_biometry_output_spec.rb +54 -0
  152. data/spec/models/brazil_cnh_match_field_date_only_spec.rb +42 -0
  153. data/spec/models/brazil_cnh_match_field_string_spec.rb +42 -0
  154. data/spec/models/brazil_cnh_provider_output_spec.rb +126 -0
  155. data/spec/models/czech_bank_id_address_spec.rb +90 -0
  156. data/spec/models/czech_bank_id_card_spec.rb +72 -0
  157. data/spec/models/czech_bank_id_provider_output_spec.rb +216 -0
  158. data/spec/models/czech_bank_id_title_spec.rb +42 -0
  159. data/spec/models/{kenya_nid_biometric2_input_spec.rb → czech_bank_id_verification_spec.rb} +9 -9
  160. data/spec/models/diia_issuer_output_spec.rb +66 -0
  161. data/spec/models/diia_provider_output_spec.rb +42 -0
  162. data/spec/models/diia_subject_output_spec.rb +60 -0
  163. data/spec/models/idemia_preview_provider_address_spec.rb +78 -0
  164. data/spec/models/idemia_preview_provider_output_spec.rb +210 -0
  165. data/spec/models/india_digilocker_aadhaar_match_date_of_birth_field_spec.rb +42 -0
  166. data/spec/models/india_digilocker_aadhaar_match_full_name_field_spec.rb +42 -0
  167. data/spec/models/india_digilocker_aadhaar_match_provider_output_spec.rb +42 -0
  168. data/spec/models/indonesia_dukcapil_match_date_of_birth_field_spec.rb +42 -0
  169. data/spec/models/indonesia_dukcapil_match_full_name_field_spec.rb +42 -0
  170. data/spec/models/indonesia_dukcapil_match_national_id_number_field_spec.rb +42 -0
  171. data/spec/models/indonesia_dukcapil_match_provider_output_spec.rb +96 -0
  172. data/spec/models/indonesia_nik_match_field_spec.rb +42 -0
  173. data/spec/models/indonesia_nik_match_spec.rb +84 -0
  174. data/spec/models/interac_address_spec.rb +60 -0
  175. data/spec/models/interac_provider_output_spec.rb +84 -0
  176. data/spec/models/itsme_address_spec.rb +66 -0
  177. data/spec/models/itsme_provider_output_spec.rb +54 -0
  178. data/spec/models/kenya_nid_match2_date_of_birth_field_spec.rb +42 -0
  179. data/spec/models/kenya_nid_match2_full_name_field_spec.rb +42 -0
  180. data/spec/models/kenya_nid_match2_national_id_number_field_spec.rb +42 -0
  181. data/spec/models/kenya_nid_match2_provider_output_spec.rb +54 -0
  182. data/spec/models/kenya_nid_match2_sex_field_spec.rb +42 -0
  183. data/spec/models/lloyds_smart_id_provider_output_spec.rb +1 -1
  184. data/spec/models/mexico_curp_provider_output_spec.rb +66 -0
  185. data/spec/models/{nigeria_nin_biometric2_input_spec.rb → nigeria_nin_match2_date_of_birth_field_spec.rb} +8 -14
  186. data/spec/models/nigeria_nin_match2_full_name_field_spec.rb +42 -0
  187. data/spec/models/nigeria_nin_match2_national_id_number_field_spec.rb +42 -0
  188. data/spec/models/nigeria_nin_match2_phone_number_field_spec.rb +42 -0
  189. data/spec/models/nigeria_nin_match2_provider_output_spec.rb +60 -0
  190. data/spec/models/nigeria_nin_match2_sex_field_spec.rb +42 -0
  191. data/spec/models/philippines_philsys_match_provider_output_spec.rb +60 -0
  192. data/spec/models/post_office_easy_id_provider_output_spec.rb +1 -1
  193. data/spec/models/provider_input_spec.rb +0 -18
  194. data/spec/models/provider_output_spec.rb +108 -6
  195. data/spec/models/south_africa_nid_lookup2_provider_output_spec.rb +90 -0
  196. data/spec/models/south_africa_nid_match2_date_of_birth_field_spec.rb +42 -0
  197. data/spec/models/south_africa_nid_match2_full_name_field_spec.rb +42 -0
  198. data/spec/models/south_africa_nid_match2_input_spec.rb +0 -6
  199. data/spec/models/south_africa_nid_match2_national_id_number_field_spec.rb +42 -0
  200. data/spec/models/south_africa_nid_match2_provider_output_spec.rb +60 -0
  201. data/spec/models/south_africa_nid_match2_sex_field_spec.rb +42 -0
  202. data/spec/models/uae_pass_provider_output_spec.rb +168 -0
  203. data/spec/models/uganda_nid_match2_date_of_birth_field_spec.rb +42 -0
  204. data/spec/models/uganda_nid_match2_national_id_number_field_spec.rb +42 -0
  205. data/spec/models/{south_africa_nid_biometric2_input_spec.rb → uganda_nid_match2_provider_output_spec.rb} +9 -9
  206. data/spec/models/uganda_nid_match2_secondary_id_number_field_spec.rb +42 -0
  207. data/spec/models/verimi_address_output_spec.rb +66 -0
  208. data/spec/models/verimi_provider_output_spec.rb +186 -0
  209. data/spec/models/yoti_deeplink_provider_output_spec.rb +1 -1
  210. data/spec/models/yoti_provider_output_spec.rb +1 -1
  211. data/spec/models/zimbabwe_nid_lookup2_provider_output_spec.rb +84 -0
  212. metadata +408 -204
  213. data/docs/KenyaNidBiometric2Input.md +0 -22
  214. data/docs/NigeriaNinBiometric2Input.md +0 -22
  215. data/docs/SouthAfricaNidBiometric2Input.md +0 -22
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::NigeriaNinMatch2ProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | [**NigeriaNinMatch2NationalIdNumberField**](NigeriaNinMatch2NationalIdNumberField.md) | Outcome of the verification of the NIN. | |
8
+ | **full_name** | [**NigeriaNinMatch2FullNameField**](NigeriaNinMatch2FullNameField.md) | Outcome of the verification of the full name. | |
9
+ | **date_of_birth** | [**NigeriaNinMatch2DateOfBirthField**](NigeriaNinMatch2DateOfBirthField.md) | Outcome of the verification of the date of birth. | [optional] |
10
+ | **sex** | [**NigeriaNinMatch2SexField**](NigeriaNinMatch2SexField.md) | Outcome of the verification of the sex. | [optional] |
11
+ | **phone_number** | [**NigeriaNinMatch2PhoneNumberField**](NigeriaNinMatch2PhoneNumberField.md) | Outcome of the verification of the phone number. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::NigeriaNinMatch2ProviderOutput.new(
19
+ national_id_number: null,
20
+ full_name: null,
21
+ date_of_birth: null,
22
+ sex: null,
23
+ phone_number: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::NigeriaNinMatch2SexField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The sex value submitted for this check. Possible input values: - Male - Female | |
8
+ | **outcome** | **String** | The outcome of comparing the submitted sex to the issuer record. Possible values: - Exact Match - No Match - Not Provided - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::NigeriaNinMatch2SexField.new(
16
+ input_value: Female,
17
+ outcome: Exact Match
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::PhilippinesPhilsysMatchProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | The individual's given name. | |
8
+ | **last_name** | **String** | The individual's family name. | |
9
+ | **middle_name** | **String** | The individual's middle name, if provided. | [optional] |
10
+ | **suffix** | **String** | The individual's name suffix, if provided. | [optional] |
11
+ | **birth_date** | **Date** | The individual's birth date. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::PhilippinesPhilsysMatchProviderOutput.new(
19
+ first_name: Juan,
20
+ last_name: Dela Cruz,
21
+ middle_name: Santos,
22
+ suffix: Jr.,
23
+ birth_date: Thu Jan 31 00:00:00 UTC 1985
24
+ )
25
+ ```
26
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
7
+ | **yoti_remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
8
8
  | **email** | **String** | The email address of the individual | [optional] |
9
9
  | **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
10
10
  | **family_name** | **String** | The family name of the individual | [optional] |
@@ -23,7 +23,7 @@
23
23
  require 'trinsic_api'
24
24
 
25
25
  instance = TrinsicApi::PostOfficeEasyIdProviderOutput.new(
26
- remember_me_id: 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
26
+ yoti_remember_me_id: Ic3NCB/dWVB1k4QPOD98IpDJ8ut04 lPHPSNV0RWikAc+szH2NrZFK1 nG+cZgaXe8,
27
27
  email: johndoe@example.com,
28
28
  given_name: John Alvin,
29
29
  family_name: Doe,
@@ -4,7 +4,6 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **kenya_nid_match_biometric_2** | [**KenyaNidBiometric2Input**](KenyaNidBiometric2Input.md) | Input for the `kenya-nid-match-biometric-2` provider | [optional] |
8
7
  | **indonesia_nik_lookup** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `indonesia-nik-lookup` provider | [optional] |
9
8
  | **china_resident_id_match** | [**ChinaResidentIdMatchInput**](ChinaResidentIdMatchInput.md) | Input for the `china-resident-id-match` provider | [optional] |
10
9
  | **indonesia_dukcapil_match** | [**IndonesiaDukcapilMatchInput**](IndonesiaDukcapilMatchInput.md) | Input for the `indonesia-dukcapil-match` provider | [optional] |
@@ -15,13 +14,11 @@
15
14
  | **kenya_nid_lookup_2** | [**KenyaNidLookup2Input**](KenyaNidLookup2Input.md) | Input for the `kenya-nid-lookup-2` provider | [optional] |
16
15
  | **south_africa_nid_lookup_2** | [**SouthAfricaNidLookup2Input**](SouthAfricaNidLookup2Input.md) | Input for the `south-africa-nid-lookup-2` provider | [optional] |
17
16
  | **south_africa_nid_match_2** | [**SouthAfricaNidMatch2Input**](SouthAfricaNidMatch2Input.md) | Input for the `south-africa-nid-match-2` provider | [optional] |
18
- | **south_africa_nid_match_biometric_2** | [**SouthAfricaNidBiometric2Input**](SouthAfricaNidBiometric2Input.md) | Input for the `south-africa-nid-match-biometric-2` provider | [optional] |
19
17
  | **nigeria_nin_lookup_2** | [**NigeriaNinLookup2Input**](NigeriaNinLookup2Input.md) | Input for the `nigeria-nin-lookup-2` provider | [optional] |
20
18
  | **cote_divoire_nid_lookup_2** | [**CoteDIvoireNidLookup2Input**](CoteDIvoireNidLookup2Input.md) | Input for the `cote-divoire-nid-lookup-2` provider | [optional] |
21
19
  | **zimbabwe_nid_lookup_2** | [**ZimbabweNidLookup2Input**](ZimbabweNidLookup2Input.md) | Input for the `zimbabwe-nid-lookup-2` provider | [optional] |
22
20
  | **nigeria_nin_match_2** | [**NigeriaNinMatch2Input**](NigeriaNinMatch2Input.md) | Input for the `nigeria-nin-match-2` provider | [optional] |
23
21
  | **uganda_nid_match_2** | [**UgandaNidMatch2Input**](UgandaNidMatch2Input.md) | Input for the `uganda-nid-match-2` provider | [optional] |
24
- | **nigeria_nin_match_biometric_2** | [**NigeriaNinBiometric2Input**](NigeriaNinBiometric2Input.md) | Input for the `nigeria-nin-match-biometric-2` provider | [optional] |
25
22
  | **nigeria_nin_lookup** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `nigeria-nin-lookup` provider | [optional] |
26
23
  | **india_digilocker_aadhaar_match** | [**AadhaarInput**](AadhaarInput.md) | Input for the `india-digilocker-aadhaar-match` provider | [optional] |
27
24
  | **india_pan_lookup** | [**IndiaPanLookupInput**](IndiaPanLookupInput.md) | Input for the `india-pan-lookup` provider | [optional] |
@@ -57,7 +54,6 @@
57
54
  require 'trinsic_api'
58
55
 
59
56
  instance = TrinsicApi::ProviderInput.new(
60
- kenya_nid_match_biometric_2: null,
61
57
  indonesia_nik_lookup: null,
62
58
  china_resident_id_match: null,
63
59
  indonesia_dukcapil_match: null,
@@ -68,13 +64,11 @@ instance = TrinsicApi::ProviderInput.new(
68
64
  kenya_nid_lookup_2: null,
69
65
  south_africa_nid_lookup_2: null,
70
66
  south_africa_nid_match_2: null,
71
- south_africa_nid_match_biometric_2: null,
72
67
  nigeria_nin_lookup_2: null,
73
68
  cote_divoire_nid_lookup_2: null,
74
69
  zimbabwe_nid_lookup_2: null,
75
70
  nigeria_nin_match_2: null,
76
71
  uganda_nid_match_2: null,
77
- nigeria_nin_match_biometric_2: null,
78
72
  nigeria_nin_lookup: null,
79
73
  india_digilocker_aadhaar_match: null,
80
74
  india_pan_lookup: null,
@@ -4,7 +4,6 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **audkenni** | [**AudkenniProviderOutput**](AudkenniProviderOutput.md) | Exposed properties for the `audkenni` provider which do not directly map to the normalized IdentityData model. | [optional] |
8
7
  | **a_at_handy_signatur_login** | [**AustriaHandySignaturProviderOutput**](AustriaHandySignaturProviderOutput.md) | Exposed properties for the `a-at-handy-signatur-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
9
8
  | **a_be_id_login** | [**BelgiumIdCardProviderOutput**](BelgiumIdCardProviderOutput.md) | Exposed properties for the `a-be-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
10
9
  | **a_edoapp_eid_login** | [**PolandEdoAppProviderOutput**](PolandEdoAppProviderOutput.md) | Exposed properties for the `a-edoapp-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
@@ -20,11 +19,15 @@
20
19
  | **a_pt_id_login** | [**PortugalIdCardProviderOutput**](PortugalIdCardProviderOutput.md) | Exposed properties for the `a-pt-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
21
20
  | **a_rs_id_login** | [**SerbiaIdCardProviderOutput**](SerbiaIdCardProviderOutput.md) | Exposed properties for the `a-rs-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
22
21
  | **apple_wallet** | [**AppleWalletProviderOutput**](AppleWalletProviderOutput.md) | Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
22
+ | **audkenni** | [**AudkenniProviderOutput**](AudkenniProviderOutput.md) | Exposed properties for the `audkenni` provider which do not directly map to the normalized IdentityData model. | [optional] |
23
23
  | **australia_connect_id** | [**ConnectIdProviderOutput**](ConnectIdProviderOutput.md) | Exposed properties for the `australia-connect-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
24
24
  | **bolivia_ci_lookup** | [**BoliviaCiProviderOutput**](BoliviaCiProviderOutput.md) | Exposed properties for the `bolivia-ci-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
25
+ | **brazil_digital_cnh** | [**BrazilCnhProviderOutput**](BrazilCnhProviderOutput.md) | Exposed properties for the `brazil-digital-cnh` Provider which do not directly map to the normalized IdentityData model. | [optional] |
26
+ | **canada_interac** | [**InteracProviderOutput**](InteracProviderOutput.md) | Exposed properties for the `canada-interac` Provider which do not directly map to the normalized IdentityData model. | [optional] |
25
27
  | **colombia_cc_lookup** | [**ColombiaCcProviderOutput**](ColombiaCcProviderOutput.md) | Exposed properties for the `colombia-cc-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
26
28
  | **cote_divoire_nid_lookup_2** | [**CoteDIvoireNidLookup2ProviderOutput**](CoteDIvoireNidLookup2ProviderOutput.md) | Exposed properties for the `cote-divoire-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
27
29
  | **el_salvador_dui_lookup** | [**ElSalvadorDuiProviderOutput**](ElSalvadorDuiProviderOutput.md) | Exposed properties for the `el-salvador-dui-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
30
+ | **czech_bank_id** | [**CzechBankIdProviderOutput**](CzechBankIdProviderOutput.md) | Exposed properties for the `czech-bank-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
28
31
  | **czech_republic_mojeid** | [**CzechMojeIdProviderOutput**](CzechMojeIdProviderOutput.md) | Exposed properties for the `czech-moje-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
29
32
  | **denmark_mitid** | [**MitIdProviderOutput**](MitIdProviderOutput.md) | Exposed properties for the `denmark-mitid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
30
33
  | **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) | Exposed properties for the `ethiopia-fayda` Provider which do not directly map to the normalized IdentityData model. | [optional] |
@@ -34,22 +37,29 @@
34
37
  | **freja** | [**FrejaProviderOutput**](FrejaProviderOutput.md) | Exposed properties for the `freja` Provider which do not directly map to the normalized IdentityData model. | [optional] |
35
38
  | **google_wallet** | [**GoogleWalletProviderOutput**](GoogleWalletProviderOutput.md) | Exposed properties for the `google-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
36
39
  | **guatemala_cui_lookup** | [**GuatemalaCuiProviderOutput**](GuatemalaCuiProviderOutput.md) | Exposed properties for the `guatemala-cui-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
40
+ | **idemia_preview** | [**IdemiaPreviewProviderOutput**](IdemiaPreviewProviderOutput.md) | Exposed properties for the `idemia-preview` Provider which do not directly map to the normalized IdentityData model. | [optional] |
37
41
  | **panama_cedula_lookup** | [**PanamaCedulaProviderOutput**](PanamaCedulaProviderOutput.md) | Exposed properties for the `panama-cedula-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
38
42
  | **india_digilocker_aadhaar** | [**DigilockerAadhaarProviderOutput**](DigilockerAadhaarProviderOutput.md) | Exposed properties for the `india-digilocker-aadhaar` Provider which do not directly map to the normalized IdentityData model. | [optional] |
39
43
  | **india_digilocker_aadhaar_fetch** | [**SignzyIndiaAadhaarFetchProviderOutput**](SignzyIndiaAadhaarFetchProviderOutput.md) | Exposed properties for the `india-digilocker-aadhaar-fetch` Provider which do not directly map to the normalized IdentityData model. | [optional] |
44
+ | **india_digilocker_aadhaar_match** | [**IndiaDigilockerAadhaarMatchProviderOutput**](IndiaDigilockerAadhaarMatchProviderOutput.md) | Exposed properties for the `india-digilocker-aadhaar-match` Provider which do not directly map to the normalized IdentityData model. | [optional] |
40
45
  | **india_pan_lookup** | [**IndiaPanLookupProviderOutput**](IndiaPanLookupProviderOutput.md) | Exposed properties for the `india-pan-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
46
+ | **indonesia_dukcapil_match** | [**IndonesiaDukcapilMatchProviderOutput**](IndonesiaDukcapilMatchProviderOutput.md) | Exposed properties for the `indonesia-dukcapil-match` Provider which do not directly map to the normalized IdentityData model. | [optional] |
47
+ | **indonesia_nik_lookup** | [**IndonesiaNikMatch**](IndonesiaNikMatch.md) | Exposed properties for the `indonesia-nik-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
41
48
  | **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] |
42
49
  | **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) | Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
43
50
  | **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] |
51
+ | **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] |
44
52
  | **korea_telco_match** | [**KoreaTelcoMatchProviderOutput**](KoreaTelcoMatchProviderOutput.md) | Exposed properties for the `korea-telco-match` Provider which do not directly map to the normalized IdentityData model. | [optional] |
45
53
  | **lloyds_smart_id** | [**LloydsSmartIdProviderOutput**](LloydsSmartIdProviderOutput.md) | Exposed properties for the `lloyds-smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
46
54
  | **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) | Exposed properties for the `mexico-curp-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
47
55
  | **mobile_id** | [**MobileIdProviderOutput**](MobileIdProviderOutput.md) | Exposed properties for the `mobile-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
48
56
  | **nigeria_nin_lookup_2** | [**NigeriaNinLookup2ProviderOutput**](NigeriaNinLookup2ProviderOutput.md) | Exposed properties for the `nigeria-nin-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
57
+ | **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] |
49
58
  | **oneid** | [**OneIdProviderOutput**](OneIdProviderOutput.md) | Exposed properties for the `oneid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
50
59
  | **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] |
51
60
  | **norway_bankid** | [**NorwegianBankIdProviderOutput**](NorwegianBankIdProviderOutput.md) | Exposed properties for the `norway-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
52
61
  | **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] |
62
+ | **philippines_philsys_match** | [**PhilippinesPhilsysMatchProviderOutput**](PhilippinesPhilsysMatchProviderOutput.md) | Exposed properties for the `philippines-philsys-match` Provider which do not directly map to the normalized IdentityData model. | [optional] |
53
63
  | **philippines_physical_national_id_qr** | [**PhilippinesPhysicalNidProviderOutput**](PhilippinesPhysicalNidProviderOutput.md) | Exposed properties for the `philippines-physical-national-id-qr` Provider which do not directly map to the normalized IdentityData model. | [optional] |
54
64
  | **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] |
55
65
  | **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] |
@@ -57,12 +67,19 @@
57
67
  | **singpass_login** | [**SingpassLoginProviderOutput**](SingpassLoginProviderOutput.md) | Exposed properties for the `singpass-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
58
68
  | **singpass_myinfo** | [**SingpassMyInfoProviderOutput**](SingpassMyInfoProviderOutput.md) | Exposed properties for the `singpass-myinfo` Provider which do not directly map to the normalized IdentityData model. | [optional] |
59
69
  | **smart_id** | [**SmartIdProviderOutput**](SmartIdProviderOutput.md) | Exposed properties for the `smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
70
+ | **south_africa_nid_lookup_2** | [**SouthAfricaNidLookup2ProviderOutput**](SouthAfricaNidLookup2ProviderOutput.md) | Exposed properties for the `south-africa-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
71
+ | **south_africa_nid_match_2** | [**SouthAfricaNidMatch2ProviderOutput**](SouthAfricaNidMatch2ProviderOutput.md) | Exposed properties for the `south-africa-nid-match-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
72
+ | **uae_pass** | [**UAEPassProviderOutput**](UAEPassProviderOutput.md) | Exposed properties for the `uae-pass` Provider which do not directly map to the normalized IdentityData model. | [optional] |
73
+ | **uganda_nid_match_2** | [**UgandaNidMatch2ProviderOutput**](UgandaNidMatch2ProviderOutput.md) | Exposed properties for the `uganda-nid-match-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
60
74
  | **uk_evisa_lookup** | [**UnitedKingdomEvisaProviderOutput**](UnitedKingdomEvisaProviderOutput.md) | Exposed properties for the `uk-evisa-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
75
+ | **verimi** | [**VerimiProviderOutput**](VerimiProviderOutput.md) | Exposed properties for the `verimi` Provider which do not directly map to the normalized IdentityData model. | [optional] |
61
76
  | **sweden_bankid** | [**SwedenBankIdProviderOutput**](SwedenBankIdProviderOutput.md) | Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
77
+ | **ukraine_diia** | [**DiiaProviderOutput**](DiiaProviderOutput.md) | Exposed properties for the `ukraine-diia` Provider which do not directly map to the normalized IdentityData model. | [optional] |
62
78
  | **usa_louisiana_wallet** | [**LaWalletProviderOutput**](LaWalletProviderOutput.md) | Exposed properties for the `usa-louisiana-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
63
79
  | **netherlands_idin** | [**NetherlandsIdinProviderOutput**](NetherlandsIdinProviderOutput.md) | Exposed properties for the `netherlands-idin` Provider which do not directly map to the normalized IdentityData model. | [optional] |
64
80
  | **yoti** | [**YotiProviderOutput**](YotiProviderOutput.md) | Exposed properties for the `yoti` Provider which do not directly map to the normalized IdentityData model. | [optional] |
65
81
  | **yoti_deeplink** | [**YotiDeeplinkProviderOutput**](YotiDeeplinkProviderOutput.md) | Exposed properties for the `yoti-deeplink` Provider which do not directly map to the normalized IdentityData model. | [optional] |
82
+ | **zimbabwe_nid_lookup_2** | [**ZimbabweNidLookup2ProviderOutput**](ZimbabweNidLookup2ProviderOutput.md) | Exposed properties for the `zimbabwe-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
66
83
 
67
84
  ## Example
68
85
 
@@ -70,7 +87,6 @@
70
87
  require 'trinsic_api'
71
88
 
72
89
  instance = TrinsicApi::ProviderOutput.new(
73
- audkenni: null,
74
90
  a_at_handy_signatur_login: null,
75
91
  a_be_id_login: null,
76
92
  a_edoapp_eid_login: null,
@@ -86,11 +102,15 @@ instance = TrinsicApi::ProviderOutput.new(
86
102
  a_pt_id_login: null,
87
103
  a_rs_id_login: null,
88
104
  apple_wallet: null,
105
+ audkenni: null,
89
106
  australia_connect_id: null,
90
107
  bolivia_ci_lookup: null,
108
+ brazil_digital_cnh: null,
109
+ canada_interac: null,
91
110
  colombia_cc_lookup: null,
92
111
  cote_divoire_nid_lookup_2: null,
93
112
  el_salvador_dui_lookup: null,
113
+ czech_bank_id: null,
94
114
  czech_republic_mojeid: null,
95
115
  denmark_mitid: null,
96
116
  ethiopia_fayda: null,
@@ -100,22 +120,29 @@ instance = TrinsicApi::ProviderOutput.new(
100
120
  freja: null,
101
121
  google_wallet: null,
102
122
  guatemala_cui_lookup: null,
123
+ idemia_preview: null,
103
124
  panama_cedula_lookup: null,
104
125
  india_digilocker_aadhaar: null,
105
126
  india_digilocker_aadhaar_fetch: null,
127
+ india_digilocker_aadhaar_match: null,
106
128
  india_pan_lookup: null,
129
+ indonesia_dukcapil_match: null,
130
+ indonesia_nik_lookup: null,
107
131
  china_resident_id_match: null,
108
132
  italy_spid: null,
109
133
  kenya_nid_lookup_2: null,
134
+ kenya_nid_match_2: null,
110
135
  korea_telco_match: null,
111
136
  lloyds_smart_id: null,
112
137
  mexico_curp_lookup: null,
113
138
  mobile_id: null,
114
139
  nigeria_nin_lookup_2: null,
140
+ nigeria_nin_match_2: null,
115
141
  oneid: null,
116
142
  peru_dni_lookup: null,
117
143
  norway_bankid: null,
118
144
  philippines_digital_national_id_qr: null,
145
+ philippines_philsys_match: null,
119
146
  philippines_physical_national_id_qr: null,
120
147
  poland_mobywatel_match: null,
121
148
  post_office_easyid: null,
@@ -123,12 +150,19 @@ instance = TrinsicApi::ProviderOutput.new(
123
150
  singpass_login: null,
124
151
  singpass_myinfo: null,
125
152
  smart_id: null,
153
+ south_africa_nid_lookup_2: null,
154
+ south_africa_nid_match_2: null,
155
+ uae_pass: null,
156
+ uganda_nid_match_2: null,
126
157
  uk_evisa_lookup: null,
158
+ verimi: null,
127
159
  sweden_bankid: null,
160
+ ukraine_diia: null,
128
161
  usa_louisiana_wallet: null,
129
162
  netherlands_idin: null,
130
163
  yoti: null,
131
- yoti_deeplink: null
164
+ yoti_deeplink: null,
165
+ zimbabwe_nid_lookup_2: null
132
166
  )
133
167
  ```
134
168
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id_number** | **String** | The user's National ID number | [optional] |
7
+ | **id_number** | **String** | The South African National Identity Number (13 digits). Issued for life by the Department of Home Affairs (DHA) and stored in the HANIS (Home Affairs National Identification System) database. The same number is mandatory for banking, employment, taxation, and voting, and is printed on both the legacy green ID book and the Smart ID Card (rolled out from 2013 onward). Format: - YYMMDD G(4) C A Z - YYMMDD is the date of birth - G(4) is the gender code (below 5000 female, 5000 or above male) - C is the citizenship indicator (0 citizen, 1 permanent resident) - A is reserved (it had a politically sensitive meaning in the past, but is currently semantically meaningless) - Z is a Luhn check digit | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -0,0 +1,36 @@
1
+ # TrinsicApi::SouthAfricaNidLookup2ProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | **String** | The South African National Identity Number (13 digits). Issued for life by the Department of Home Affairs (DHA) and stored in the HANIS (Home Affairs National Identification System) database. The same number is mandatory for banking, employment, taxation, and voting, and is printed on both the legacy green ID book and the Smart ID Card (rolled out from 2013 onward). Format: - YYMMDD G(4) C A Z - YYMMDD is the date of birth - G(4) is the gender code (below 5000 female, 5000 or above male) - C is the citizenship indicator (0 citizen, 1 permanent resident) - A is reserved (it had a politically sensitive meaning in the past, but is currently semantically meaningless) - Z is a Luhn check digit | |
8
+ | **citizenship_status** | **String** | Citizenship status of the individual. Possible values: - Citizen - PermanentResident | |
9
+ | **first_name** | **String** | First name of the individual. | |
10
+ | **family_name** | **String** | Family name of the individual. | |
11
+ | **full_name** | **String** | Full name of the individual. | |
12
+ | **sex** | **String** | Sex of the individual. Possible values: - Male - Female | |
13
+ | **date_of_birth** | **Date** | Date of birth of the individual. | |
14
+ | **nationality** | **String** | Nationality of the individual as an ISO 3166-1 alpha-2 country code. | |
15
+ | **date_of_death** | **Date** | Date of death of the individual, if recorded by DHA (Department of Home Affairs). Null if the individual is alive, or the data is missing from the registry. | [optional] |
16
+ | **birth_country** | **String** | Country of birth of the individual as an ISO 3166-1 alpha-2 country code. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'trinsic_api'
22
+
23
+ instance = TrinsicApi::SouthAfricaNidLookup2ProviderOutput.new(
24
+ national_id_number: 9001315000082,
25
+ citizenship_status: Citizen,
26
+ first_name: THABO,
27
+ family_name: MOKOENA,
28
+ full_name: THABO MOKOENA,
29
+ sex: Male,
30
+ date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
31
+ nationality: ZA,
32
+ date_of_death: Tue Mar 12 00:00:00 UTC 2024,
33
+ birth_country: ZA
34
+ )
35
+ ```
36
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::SouthAfricaNidMatch2DateOfBirthField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **Date** | The date of birth submitted for this check. | |
8
+ | **outcome** | **String** | The outcome of comparing the submitted date of birth to the issuer record. Possible values: - Exact Match - Partial Match - Transposed - No Match - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::SouthAfricaNidMatch2DateOfBirthField.new(
16
+ input_value: Tue Jan 30 00:00:00 UTC 1990,
17
+ outcome: Partial Match
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::SouthAfricaNidMatch2FullNameField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The full name string submitted for this check (as provided in the match input). | |
8
+ | **outcome** | **String** | The outcome of comparing the submitted full name to the issuer record. Possible values: - Exact Match - Partial Match - Transposed - No Match - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::SouthAfricaNidMatch2FullNameField.new(
16
+ input_value: MOKOENA THABO,
17
+ outcome: Transposed
18
+ )
19
+ ```
20
+
@@ -4,13 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id_number** | **String** | The user's South African National ID number | [optional] |
7
+ | **id_number** | **String** | The South African National Identity Number (13 digits). Issued for life by the Department of Home Affairs (DHA) and stored in the HANIS (Home Affairs National Identification System) database. The same number is mandatory for banking, employment, taxation, and voting, and is printed on both the legacy green ID book and the Smart ID Card (rolled out from 2013 onward). Format: - YYMMDD G(4) C A Z - YYMMDD is the date of birth - G(4) is the gender code (below 5000 female, 5000 or above male) - C is the citizenship indicator (0 citizen, 1 permanent resident) - A is reserved (it had a politically sensitive meaning in the past, but is currently semantically meaningless) - Z is a Luhn check digit | [optional] |
8
8
  | **given_name** | **String** | The user's first name as it appears in their National ID | [optional] |
9
9
  | **family_name** | **String** | The user's last name as it appears in their National ID | [optional] |
10
10
  | **middle_name** | **String** | The user's middle name as it appears in their National ID (optional) | [optional] |
11
11
  | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
12
12
  | **sex** | [**SouthAfricaNidMatch2InputSex**](SouthAfricaNidMatch2InputSex.md) | The user's sex as it appears in their National ID | [optional] |
13
- | **phone_number** | **String** | The user's phone number as it appears in their National ID (optional). Must be in E.164 international format: \"+27XXXXXXXXX\" | [optional] |
14
13
 
15
14
  ## Example
16
15
 
@@ -23,8 +22,7 @@ instance = TrinsicApi::SouthAfricaNidMatch2Input.new(
23
22
  family_name: null,
24
23
  middle_name: null,
25
24
  date_of_birth: null,
26
- sex: null,
27
- phone_number: null
25
+ sex: null
28
26
  )
29
27
  ```
30
28
 
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::SouthAfricaNidMatch2NationalIdNumberField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The South African National Identity Number (13 digits) is issued for life by the Department of Home Affairs (DHA) and stored in the Home Affairs National Identification System (HANIS) database. The same number is mandatory for banking, employment, taxation, and voting, and is printed on both the legacy green ID book and the Smart ID Card (rolled out from 2013 onward). Format: - YYMMDD G(4) C A Z - YYMMDD is the date of birth - G(4) is the gender code (below 5000 female, 5000 or above male) - C is the citizenship indicator (0 citizen, 1 permanent resident) - A is reserved (it had a politically sensitive meaning in the past, but is currently semantically meaningless) - Z is a Luhn check digit | |
8
+ | **outcome** | **String** | The outcome of verifying the national ID number. Possible values: - Verified - Not Verified - Not Done - Issuer Unavailable - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::SouthAfricaNidMatch2NationalIdNumberField.new(
16
+ input_value: 9001315000082,
17
+ outcome: Verified
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::SouthAfricaNidMatch2ProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | [**SouthAfricaNidMatch2NationalIdNumberField**](SouthAfricaNidMatch2NationalIdNumberField.md) | Outcome of the verification of the national ID number. | |
8
+ | **full_name** | [**SouthAfricaNidMatch2FullNameField**](SouthAfricaNidMatch2FullNameField.md) | Outcome of the verification of the full name. | |
9
+ | **date_of_birth** | [**SouthAfricaNidMatch2DateOfBirthField**](SouthAfricaNidMatch2DateOfBirthField.md) | Outcome of the verification of the date of birth. | [optional] |
10
+ | **sex** | [**SouthAfricaNidMatch2SexField**](SouthAfricaNidMatch2SexField.md) | Outcome of the verification of the sex. | [optional] |
11
+ | **citizenship_status** | **String** | Citizenship status of the individual, if the ID number is valid. Possible values: - Citizen - PermanentResident | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::SouthAfricaNidMatch2ProviderOutput.new(
19
+ national_id_number: null,
20
+ full_name: null,
21
+ date_of_birth: null,
22
+ sex: null,
23
+ citizenship_status: Citizen
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::SouthAfricaNidMatch2SexField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The sex value submitted for this check. Possible input values: - Male - Female | |
8
+ | **outcome** | **String** | The outcome of comparing the submitted sex to the issuer record. Possible values: - Exact Match - No Match - Not Provided - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::SouthAfricaNidMatch2SexField.new(
16
+ input_value: Female,
17
+ outcome: No Match
18
+ )
19
+ ```
20
+
@@ -0,0 +1,62 @@
1
+ # TrinsicApi::UAEPassProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sub** | **String** | OIDC subject (`sub`) returned by UAE Pass. This is an opaque identifier for the authenticated user in the UAE Pass OIDC transaction. It can be prefixed or unprefixed; do not parse this value or assume it matches the Emirates ID number, UAE Pass UUID, or UAE unified ID. | [optional] |
8
+ | **full_name_arabic** | **String** | Full name in Arabic. | [optional] |
9
+ | **gender** | **String** | Normalized sex parsed from the UAE Pass gender value. Possible values: - Male - Female - Unknown - NotApplicable This is null when the UAE Pass value cannot be parsed. | [optional] |
10
+ | **mobile** | **String** | Mobile number. | [optional] |
11
+ | **last_name_english** | **String** | Last name in the Latin-script value returned by UAE Pass. | [optional] |
12
+ | **full_name_english** | **String** | Full name in the Latin-script value returned by UAE Pass. | [optional] |
13
+ | **uae_pass_uuid** | **String** | UAE Pass UUID. The unique UAE Pass user identifier. It is separate from the OIDC subject identifier, Emirates ID number, and UAE unified ID. | [optional] |
14
+ | **smart_pass_uuid** | **String** | SmartPass unique user identifier, if returned. SmartPass was a previous UAE government single-sign-on identity system. UAE Pass can return this legacy identifier for SOP2 and SOP3 accounts that were verified through SmartPass. | [optional] |
15
+ | **last_name_arabic** | **String** | Last name in Arabic. | [optional] |
16
+ | **emirates_id_number** | **String** | Verified Emirates ID number, if returned for the user profile type and scope. The Emirates ID is issued by the Federal Authority for Identity, Citizenship, Customs and Port Security (ICP). The number is a 15-digit identifier following the format 784-YYYY-NNNNNNN-C: The number is a 15-digit identifier following the format 784-YYYY-NNNNNNN-C: - 784: UAE ISO 3166-1 numeric country code. - YYYY: A year value, which could be birth year, registration year, or another year value. This should not be relied upon to infer birth or registration details. - NNNNNNN: 7-digit random serial number for the individual. - C: Check digit. This field may not be returned for visitor profiles. | [optional] |
17
+ | **id_type** | **String** | ID type. Known values: - ID: Emirates ID or national identity document. Returned for SOP2 and SOP3 citizen or resident profiles and SOP3 visitor profiles. | [optional] |
18
+ | **nationality_english** | **String** | Nationality in the Latin-script value returned by UAE Pass. | [optional] |
19
+ | **first_name_english** | **String** | First name in the Latin-script value returned by UAE Pass. | [optional] |
20
+ | **user_type** | **String** | UAE Pass user type. Possible values: - SOP1: Basic account. Unverified account with verified email and mobile number. - SOP2: Advanced account. Verified account with Emirates ID verification through SmartPass, Dubai ID, or Emirates ID PIN registration. - SOP3: Qualified account. Verified account with Emirates ID verification through finger biometrics or face biometrics. | [optional] |
21
+ | **nationality_arabic** | **String** | Nationality in Arabic. | [optional] |
22
+ | **first_name_arabic** | **String** | First name in Arabic. | [optional] |
23
+ | **email** | **String** | Email address. | [optional] |
24
+ | **title_english** | **String** | Title in the Latin-script value returned by UAE Pass. Returned for SOP2 and SOP3 citizen or resident profiles and SOP3 visitor profiles. | [optional] |
25
+ | **title_arabic** | **String** | Title in Arabic. Returned for SOP2 and SOP3 citizen or resident profiles and SOP3 visitor profiles. | [optional] |
26
+ | **profile_type** | **Integer** | UAE Pass profile type, if returned for the requested scope. Possible values: - 1: Citizen or resident profile. - 2: Visitor profile. | [optional] |
27
+ | **unified_id** | **String** | UAE unified ID, if returned for the requested scope. A unique ID for the user. It is separate from the Emirates ID number, UAE Pass UUID, and OIDC subject identifier. | [optional] |
28
+ | **authentication_assurance_level** | **String** | UAE Pass authentication assurance level, if present. This classifies the authentication policy that was satisfied for the session. Known values include: - urn:safelayer:tws:policies:authentication:level:low - urn:safelayer:tws:policies:authentication:level:high | [optional] |
29
+ | **authentication_methods** | **Array<String>** | UAE Pass authentication methods, if present. This classifies the concrete methods used during authentication. Known values include: - urn:safelayer:tws:policies:authentication:adaptive:methods:mobileid - urn:uae:authentication:method:verified - urn:oasis:names:tc:SAML:1:0:am:password | [optional] |
30
+
31
+ ## Example
32
+
33
+ ```ruby
34
+ require 'trinsic_api'
35
+
36
+ instance = TrinsicApi::UAEPassProviderOutput.new(
37
+ sub: UAEPASS/7a05992e-3244-49d3-bcbc-7894c8fca25e,
38
+ full_name_arabic: محمد أحمد,
39
+ gender: Male,
40
+ mobile: +971501234567,
41
+ last_name_english: Ahmed,
42
+ full_name_english: Mohammed Ahmed,
43
+ uae_pass_uuid: 2f9c7bb1-1ef1-4cb8-a91f-ef5e6a8a4c16,
44
+ smart_pass_uuid: b1320896-fb2e-5140-baf0-fa915eb9be5d,
45
+ last_name_arabic: أحمد,
46
+ emirates_id_number: 784199012345676,
47
+ id_type: ID,
48
+ nationality_english: United Arab Emirates,
49
+ first_name_english: Mohammed,
50
+ user_type: SOP3,
51
+ nationality_arabic: الإمارات العربية المتحدة,
52
+ first_name_arabic: محمد,
53
+ email: mohammed.ahmed@example.ae,
54
+ title_english: Dr.,
55
+ title_arabic: .د,
56
+ profile_type: 1,
57
+ unified_id: 123456789,
58
+ authentication_assurance_level: urn:safelayer:tws:policies:authentication:level:high,
59
+ authentication_methods: ["urn:uae:authentication:method:verified"]
60
+ )
61
+ ```
62
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::UgandaNidMatch2DateOfBirthField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **Date** | The date of birth submitted for this check. | |
8
+ | **outcome** | **String** | The outcome of comparing the submitted date of birth with NIRA database. For Uganda match, partial or transposed outcomes are not used; matching is exact or no match. Possible values: - Exact Match - No Match - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::UgandaNidMatch2DateOfBirthField.new(
16
+ input_value: Wed Sep 20 00:00:00 UTC 2000,
17
+ outcome: Exact Match
18
+ )
19
+ ```
20
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id_number** | **String** | The user's Uganda National ID number (NIN) - 14 alphanumeric characters | [optional] |
7
+ | **id_number** | **String** | Uganda National ID number (NID) assigned by the National Identification and Registration Authority (NIRA). Format: - 14 alphanumeric characters (A-Z, 0-9) - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by NIRA | [optional] |
8
8
  | **secondary_id_number** | **String** | The card number on the document (secondary ID number). Required for Uganda Basic KYC instead of first name and last name. | [optional] |
9
9
  | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
10
10
 
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::UgandaNidMatch2NationalIdNumberField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | Uganda National ID number (NID) assigned by the National Identification and Registration Authority (NIRA). Format: - 14 alphanumeric characters (A-Z, 0-9) - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by NIRA | |
8
+ | **outcome** | **String** | The outcome of looking up the NID in NIRA database. Possible values: - Verified - Not Verified - Not Done - Issuer Unavailable - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::UgandaNidMatch2NationalIdNumberField.new(
16
+ input_value: AB12CD34EF5678,
17
+ outcome: Verified
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::UgandaNidMatch2ProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | [**UgandaNidMatch2NationalIdNumberField**](UgandaNidMatch2NationalIdNumberField.md) | Outcome of verifying the national identification number in the NIRA database. | |
8
+ | **secondary_id_number** | [**UgandaNidMatch2SecondaryIdNumberField**](UgandaNidMatch2SecondaryIdNumberField.md) | Outcome of comparing the submitted card number with the NIRA database. | |
9
+ | **date_of_birth** | [**UgandaNidMatch2DateOfBirthField**](UgandaNidMatch2DateOfBirthField.md) | Outcome of comparing the submitted date of birth with the NIRA database. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::UgandaNidMatch2ProviderOutput.new(
17
+ national_id_number: null,
18
+ secondary_id_number: null,
19
+ date_of_birth: null
20
+ )
21
+ ```
22
+