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,20 @@
1
+ # TrinsicApi::IndiaDigilockerAadhaarMatchDateOfBirthField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **Date** | The date of birth submitted for this check, as provided in the match input. | |
8
+ | **outcome** | **Boolean** | Whether the submitted date of birth matched the issuer record for this session. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndiaDigilockerAadhaarMatchDateOfBirthField.new(
16
+ input_value: Thu Jan 31 00:00:00 UTC 1985,
17
+ outcome: true
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::IndiaDigilockerAadhaarMatchFullNameField
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** | **Float** | Full-name similarity score from the DigiLocker match result for this session. Format: - Between 0.0 to 1.0, where higher values indicate closer agreement with the Aadhaar record. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndiaDigilockerAadhaarMatchFullNameField.new(
16
+ input_value: Rajesh Kumar Sharma,
17
+ outcome: 0.92
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::IndiaDigilockerAadhaarMatchProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | [**IndiaDigilockerAadhaarMatchFullNameField**](IndiaDigilockerAadhaarMatchFullNameField.md) | Full name submitted for this DigiLocker Aadhaar match and the similarity score returned for that value. | [optional] |
8
+ | **date_of_birth** | [**IndiaDigilockerAadhaarMatchDateOfBirthField**](IndiaDigilockerAadhaarMatchDateOfBirthField.md) | Date of birth submitted for this DigiLocker Aadhaar match and whether it matched the issuer record for this session. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndiaDigilockerAadhaarMatchProviderOutput.new(
16
+ full_name: null,
17
+ date_of_birth: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::IndonesiaDukcapilMatchDateOfBirthField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **Date** | The date of birth submitted for this check. | |
8
+ | **outcome** | **Float** | The provider assessment result for the submitted date of birth. Local integration code expects the provider to return 0 or 1 for this assessment. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndonesiaDukcapilMatchDateOfBirthField.new(
16
+ input_value: Thu Jan 31 00:00:00 UTC 1980,
17
+ outcome: 1
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::IndonesiaDukcapilMatchFullNameField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The full name submitted for this check. | |
8
+ | **outcome** | **Float** | The provider assessment result for the submitted full name. Format: numeric score from 0.0 to 1.0, where higher values indicate closer agreement with the Dukcapil record. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndonesiaDukcapilMatchFullNameField.new(
16
+ input_value: Siti Aminah,
17
+ outcome: 0.98
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::IndonesiaDukcapilMatchNationalIdNumberField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The NIK (Nomor Induk Kependudukan) submitted for this check. NIK is Indonesia's unique population identity number, issued by Indonesia's population administration and civil registration authority (Dukcapil) under the Ministry of Home Affairs. Format: - 16 numeric digits. - Digits 1-2 are the province code. - Digits 3-4 are the regency or city code within that province. - Digits 5-6 are the district code within that regency or city. - Digits 7-12 encode date of birth as DDMMYY. For female NIK holders, the day is increased by 40. - Digits 13-16 are an issuance serial number. | |
8
+ | **outcome** | **Float** | The provider assessment result for the submitted NIK. Local integration code expects the provider to return 0 or 1 for this assessment. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndonesiaDukcapilMatchNationalIdNumberField.new(
16
+ input_value: 3171017101800001,
17
+ outcome: 1
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # TrinsicApi::IndonesiaDukcapilMatchProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | [**IndonesiaDukcapilMatchNationalIdNumberField**](IndonesiaDukcapilMatchNationalIdNumberField.md) | NIK submitted for this Dukcapil match and the assessment result returned for that value. | |
8
+ | **full_name** | [**IndonesiaDukcapilMatchFullNameField**](IndonesiaDukcapilMatchFullNameField.md) | Full name submitted for this Dukcapil match and the assessment result returned for that value. | |
9
+ | **date_of_birth** | [**IndonesiaDukcapilMatchDateOfBirthField**](IndonesiaDukcapilMatchDateOfBirthField.md) | Date of birth submitted for this Dukcapil match and the assessment result returned for that value. | |
10
+ | **province_code** | **String** | Two-digit Indonesian government administrative region code for the province, extracted from digits 1-2 of the submitted NIK number. Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. The first digit indicates the island group: 1-2 Sumatra, 3-4 Java, 5 Bali and Nusa Tenggara, 6 Kalimantan, 7 Sulawesi, 8 Maluku, and 9 Papua. The second digit follows the province creation order. | |
11
+ | **regency_or_city_code** | **String** | Four-digit Indonesian government administrative region code for the regency or city, extracted from digits 1-4 of the submitted NIK number. Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code followed by a two-digit regency or city sequence; suffixes 01-69 identify regencies and suffixes 71-99 identify cities. The NIK stores this value without dot separators. | |
12
+ | **district_code** | **String** | Six-digit Indonesian government administrative region code for the district (kecamatan), extracted from digits 1-6 of the submitted NIK number. Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code, two-digit regency or city code, and two-digit district sequence. The NIK stores this value without dot separators. | |
13
+ | **sex_national_id_number** | **String** | Sex extracted from the birth-day portion of the submitted NIK number. Known values: - Male: The encoded day value is 40 or lower. - Female: The encoded day value is greater than 40. | |
14
+ | **serial_number** | **String** | Four-digit issuance serial number extracted from digits 13-16 of the submitted NIK number. | |
15
+ | **phone_number** | **String** | The phone number submitted for this verification, if provided. Format: international E.164 phone number. | [optional] |
16
+ | **consent_given_at** | **Time** | The consent timestamp submitted for this verification. | |
17
+ | **email** | **String** | The email address submitted for this verification, if provided. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'trinsic_api'
23
+
24
+ instance = TrinsicApi::IndonesiaDukcapilMatchProviderOutput.new(
25
+ national_id_number: null,
26
+ full_name: null,
27
+ date_of_birth: null,
28
+ province_code: 31,
29
+ regency_or_city_code: 3171,
30
+ district_code: 317101,
31
+ sex_national_id_number: Female,
32
+ serial_number: 0001,
33
+ phone_number: +6281234567890,
34
+ consent_given_at: 2026-01-31T08:30+07:00,
35
+ email: siti.aminah@example.id
36
+ )
37
+ ```
38
+
@@ -0,0 +1,34 @@
1
+ # TrinsicApi::IndonesiaNikMatch
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | [**IndonesiaNikMatchField**](IndonesiaNikMatchField.md) | Full name match result from Indonesia NIK verification. | [optional] |
8
+ | **date_of_birth** | [**IndonesiaNikMatchField**](IndonesiaNikMatchField.md) | Date of birth match result from Indonesia NIK verification. | [optional] |
9
+ | **national_id_number** | [**IndonesiaNikMatchField**](IndonesiaNikMatchField.md) | NIK number match result from Indonesia NIK verification. NIK stands for Nomor Induk Kependudukan. It is Indonesia's unique population identity number, issued by Indonesia's population administration and civil registration authority (Dukcapil) under the Ministry of Home Affairs. A NIK has 16 digits: - Digits 1-2 are the province code. - Digits 3-4 are the regency or city code within that province. - Digits 5-6 are the district code within that regency or city. - Digits 7-12 encode date of birth as DDMMYY. For female NIK holders, the day is increased by 40. - Digits 13-16 are an issuance serial number. | [optional] |
10
+ | **province_code** | **String** | Two-digit province code extracted from digits 1-2 of the NIK number. | [optional] |
11
+ | **regency_or_city_code** | **String** | Four-digit regency or city code extracted from digits 1-4 of the NIK number, including the province code prefix. | [optional] |
12
+ | **district_code** | **String** | Six-digit district code extracted from digits 1-6 of the NIK number, including province and regency/city code prefixes. | [optional] |
13
+ | **date_of_birth_national_id_number** | **Date** | Date of birth extracted from digits 7-12 of the NIK number. The NIK encodes date of birth as DDMMYY. For female NIK holders, the encoded day is increased by 40 before being stored in the NIK number. | [optional] |
14
+ | **sex_national_id_number** | **String** | Sex extracted from the birth-day portion of the NIK number. The encoded day value is increased by 40 for female NIK holders. | [optional] |
15
+ | **serial_number** | **String** | Four-digit issuance serial number extracted from digits 13-16 of the NIK number. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'trinsic_api'
21
+
22
+ instance = TrinsicApi::IndonesiaNikMatch.new(
23
+ full_name: null,
24
+ date_of_birth: null,
25
+ national_id_number: null,
26
+ province_code: 31,
27
+ regency_or_city_code: 3171,
28
+ district_code: 317101,
29
+ date_of_birth_national_id_number: Thu Jan 31 00:00:00 UTC 1980,
30
+ sex_national_id_number: Female,
31
+ serial_number: 0001
32
+ )
33
+ ```
34
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::IndonesiaNikMatchField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content** | **String** | Raw value used for this match field. | |
8
+ | **match_value** | **Boolean** | Whether the value matched. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::IndonesiaNikMatchField.new(
16
+ content: Siti Aminah,
17
+ match_value: true
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::InteracAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **street_address** | **String** | The address line or street address. | [optional] |
8
+ | **locality** | **String** | The city or locality. | [optional] |
9
+ | **region** | **String** | The province, state, territory, or region. | [optional] |
10
+ | **postal_code** | **String** | The postal code. | [optional] |
11
+ | **country** | **String** | The address's ISO 3166-1 alpha-2 country code. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::InteracAddress.new(
19
+ street_address: 4101 Yonge Street,
20
+ locality: Toronto,
21
+ region: ON,
22
+ postal_code: M2P 1N6,
23
+ country: CA
24
+ )
25
+ ```
26
+
@@ -0,0 +1,34 @@
1
+ # TrinsicApi::InteracProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sub** | **String** | The OpenID Connect subject identifier for the verified individual. | [optional] |
8
+ | **given_name** | **String** | The given name of the verified individual. | [optional] |
9
+ | **middle_name** | **String** | The middle name of the verified individual. | [optional] |
10
+ | **family_name** | **String** | The family name of the verified individual. | [optional] |
11
+ | **title** | **String** | The title or honorific of the verified individual, when supplied by the source. | [optional] |
12
+ | **date_of_birth** | **Date** | The date of birth of the verified individual. | [optional] |
13
+ | **email** | **String** | The email address of the verified individual. | [optional] |
14
+ | **phone_number** | **String** | The phone number of the verified individual in E.164 format. | [optional] |
15
+ | **address** | [**InteracAddress**](InteracAddress.md) | The verified address. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'trinsic_api'
21
+
22
+ instance = TrinsicApi::InteracProviderOutput.new(
23
+ sub: 78d41cff-678e-4a3e-9482-afa43ceae222,
24
+ given_name: John,
25
+ middle_name: Montgomery,
26
+ family_name: Doe,
27
+ title: Mr,
28
+ date_of_birth: Wed Mar 03 00:00:00 UTC 1965,
29
+ email: john.doe@example.com,
30
+ phone_number: +14169378708,
31
+ address: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::ItsmeAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **street_address** | **String** | The full street address on a single line. | [optional] |
8
+ | **street** | **String** | The street name component of the address. | [optional] |
9
+ | **house_number** | **String** | The house number component of the address. | [optional] |
10
+ | **postal_code** | **String** | The postal code of the address. | [optional] |
11
+ | **city** | **String** | The city of the address. | [optional] |
12
+ | **country** | **String** | The country of the address as an ISO 3166-1 alpha-2 code. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::ItsmeAddress.new(
20
+ street_address: Rue du Bailli 81,
21
+ street: Rue du Bailli,
22
+ house_number: 81,
23
+ postal_code: 1050,
24
+ city: Ixelles,
25
+ country: BE
26
+ )
27
+ ```
28
+
@@ -9,6 +9,15 @@
9
9
  | **date_of_birth** | **Date** | The date of birth of the verified individual | |
10
10
  | **hashed_national_register_number** | **String** | The hashed version of the Belgian National Register Number of the verified individual. By default, itsme does not return the raw National Register Number of the individual; instead, only a hashed version is returned. Your account must be approved by itsme to receive the raw, unhashed National Register Number. | [optional] |
11
11
  | **national_register_number** | **String** | The raw (not hashed) Belgian National Register Number (\"Rijksregisternummer\") of the verified individual. Only returned if your account has been explicitly authorized to receive it by itsme; by law, this data is considered sensitive personal data. This is an 11-digit number in the format YYMMDDXXXCC, where: - YYMMDD represents the individual's date of birth (year, month, day). - XXX is a sequential birth number, odd for females and even for males. - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97) For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation. | [optional] |
12
+ | **email** | **String** | The individual's email address. | [optional] |
13
+ | **phone_number** | **String** | The individual's phone number in international format. | [optional] |
14
+ | **gender** | **String** | The individual's gender. Possible values: - Male - Female - Unknown - Not Applicable | [optional] |
15
+ | **nationality** | **String** | The individual's nationality as an ISO 3166-1 alpha-3 code. | [optional] |
16
+ | **birth_place** | **String** | The individual's place of birth. | [optional] |
17
+ | **document_number** | **String** | The document number | [optional] |
18
+ | **identity_document_expiration_date** | **Date** | The expiration date of the identity document. | [optional] |
19
+ | **language** | **String** | The individual's language as an ISO 639-1 code. Expected values: NL, FR, DE, EN. | [optional] |
20
+ | **address** | [**ItsmeAddress**](ItsmeAddress.md) | The individual's address | [optional] |
12
21
 
13
22
  ## Example
14
23
 
@@ -20,7 +29,16 @@ instance = TrinsicApi::ItsmeProviderOutput.new(
20
29
  last_name: Doe,
21
30
  date_of_birth: Tue Dec 10 00:00:00 UTC 1985,
22
31
  hashed_national_register_number: 5d17e158243dff0bd79fbfd06b27b80d04a40a6a0425e1bbb474c7634a2918f7,
23
- national_register_number: 83122412413
32
+ national_register_number: 83122412413,
33
+ email: louison.brunet@example.com,
34
+ phone_number: +32479350919,
35
+ gender: Male,
36
+ nationality: BEL,
37
+ birth_place: Namur,
38
+ document_number: 351907284611,
39
+ identity_document_expiration_date: Tue Jun 16 00:00:00 UTC 2026,
40
+ language: EN,
41
+ address: null
24
42
  )
25
43
  ```
26
44
 
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::KenyaNidMatch2DateOfBirthField
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 against the Integrated Population Registration System (IPRS). 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::KenyaNidMatch2DateOfBirthField.new(
16
+ input_value: Wed Jan 02 00:00:00 UTC 1985,
17
+ outcome: Partial Match
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::KenyaNidMatch2FullNameField
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 against the Integrated Population Registration System (IPRS). 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::KenyaNidMatch2FullNameField.new(
16
+ input_value: OTIENO JUMA ODHIAMBO,
17
+ outcome: Transposed
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::KenyaNidMatch2NationalIdNumberField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba). This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is up to 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). Format: - Up to 8 digits for National ID, unique and sequentially generated - 9 digits for Maisha Namba UPI, unique and randomly generated - Neither number encodes any information about the individual | |
8
+ | **outcome** | **String** | The outcome of verifying the national ID number against the Integrated Population Registration System (IPRS). 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::KenyaNidMatch2NationalIdNumberField.new(
16
+ input_value: 12345678,
17
+ outcome: Verified
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::KenyaNidMatch2ProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | [**KenyaNidMatch2NationalIdNumberField**](KenyaNidMatch2NationalIdNumberField.md) | Outcome of the verification of the national ID number. | |
8
+ | **full_name** | [**KenyaNidMatch2FullNameField**](KenyaNidMatch2FullNameField.md) | Outcome of the verification of the full name. | |
9
+ | **date_of_birth** | [**KenyaNidMatch2DateOfBirthField**](KenyaNidMatch2DateOfBirthField.md) | Outcome of the verification of the date of birth. | [optional] |
10
+ | **sex** | [**KenyaNidMatch2SexField**](KenyaNidMatch2SexField.md) | Outcome of the verification of the sex. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::KenyaNidMatch2ProviderOutput.new(
18
+ national_id_number: null,
19
+ full_name: null,
20
+ date_of_birth: null,
21
+ sex: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::KenyaNidMatch2SexField
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 against the Integrated Population Registration System (IPRS). Possible values: - Exact Match - No Match - Not Provided - Not Returned | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::KenyaNidMatch2SexField.new(
16
+ input_value: Female,
17
+ outcome: No Match
18
+ )
19
+ ```
20
+
@@ -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::LloydsSmartIdProviderOutput.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,18 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | First name of the individual. | [optional] |
8
+ | **father_last_name** | **String** | The last name of the father of the individual. | [optional] |
9
+ | **mother_last_name** | **String** | The last name of the mother of the individual. | [optional] |
10
+ | **gender** | **String** | The gender of the individual. List of possible values: - Male - Female | [optional] |
11
+ | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
12
+ | **country_of_birth** | **String** | The country of birth of the individual. | [optional] |
13
+ | **state_of_birth** | **String** | The state of birth of the individual. | [optional] |
14
+ | **curp** | **String** | The CURP (Clave Única de Registro de Población) that was verified. A CURP code is a unique identifier assigned to individuals in Mexico. It is 18 alphanumeric characters, with a structured meaning: ABCD YYMMDD G SS XYZ M C The first 4 letters (ABCD): A: The first letter of the paternal last name. B: First internal vowel of paternal last name. C: First letter of maternal last name. D: First letter of first name. YYMMDD: 2-digit year, month, day. G: Gender, H for Hombre (male) and M for Mujer (female). SS: State code (2 letters), e.g. NL for Nuevo León. X: First internal consonant of paternal last name. Y: First internal consonant of maternal last name. Z: First internal consonant of given name. M: Millennium indicator (0-9 for pre-2000 birth date, A-Z for post-2000's birth dates. C: Checksum character | [optional] |
7
15
  | **curp_status** | **String** | Curp status for the subject. Possible values: - AN: Alta Normal (Normal registration) - Active - AH: Alta con Homonimia (Registration with homonymy) - Active - RCC: Registro de cambio afectando a CURP (Change affecting CURP) - Active - RCN: Registro de cambio no afectando a CURP (Change not affecting CURP) - Active - BAP: Baja por documento apócrifo (Low due to apocryphal document) - Inactive - BSU: Baja sin uso (Low curp without use) - Inactive - BD: Baja por defunción (Low curp due to death) - Inactive - BDM: Baja administrativa (Low, due to administrative process) - Inactive - BDP: Baja por adopción (Low, due to adoption) - Inactive - BJD: Baja Judicial (Low for judicial reasons) - Inactive | [optional] |
16
+ | **registration_year** | **Integer** | The year the CURP number was registered in. | [optional] |
17
+ | **registration_state** | **String** | The state the CURP number was registered in. | [optional] |
18
+ | **act_number** | **String** | The ACT (Número de Acta) number of the individual. The Act number is a civil registry index number. Various state have various formats of specifying these. | [optional] |
8
19
 
9
20
  ## Example
10
21
 
@@ -12,7 +23,18 @@
12
23
  require 'trinsic_api'
13
24
 
14
25
  instance = TrinsicApi::MexicoCurpProviderOutput.new(
15
- curp_status: AN
26
+ first_name: Juan,
27
+ father_last_name: Pérez,
28
+ mother_last_name: García,
29
+ gender: Male,
30
+ date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
31
+ country_of_birth: MEXICO,
32
+ state_of_birth: Veracruz,
33
+ curp: PEGJ430815HVZRRN08,
34
+ curp_status: AN,
35
+ registration_year: 1976,
36
+ registration_state: DISTRITO FEDERAL,
37
+ act_number: 00016
16
38
  )
17
39
  ```
18
40
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id_number** | **String** | The user's National ID number (NIN) | [optional] |
7
+ | **id_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment. Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -10,7 +10,7 @@
10
10
  | **sex** | **String** | The sex of the ID holder. Possible values: - Male - Female | [optional] |
11
11
  | **date_of_birth** | **Date** | The date of birth of the ID holder. | [optional] |
12
12
  | **birth_country** | **String** | Country of birth as an ISO 3166-1 alpha-2 code. | [optional] |
13
- | **national_identity_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission upon enrollment. Format: 11 numeric digits (regex: /^[0-9]{11}$/). The digits are validated using the Verhoeff algorithm, meaning the last digit serves as a check digit. | |
13
+ | **national_identity_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment. Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm | |
14
14
  | **phone_number** | **String** | Phone number registered with the National Identity Management Commission. | [optional] |
15
15
  | **email** | **String** | Email address registered with the National Identity Management Commission. | [optional] |
16
16
  | **address** | **String** | Full residential address as a single string, normalized to lowercase without delimiters. | [optional] |
@@ -29,7 +29,7 @@ instance = TrinsicApi::NigeriaNinLookup2ProviderOutput.new(
29
29
  sex: Male,
30
30
  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
31
31
  birth_country: NG,
32
- national_identity_number: 12345678901,
32
+ national_identity_number: 12345678902,
33
33
  phone_number: +2340123456789,
34
34
  email: user@example.com,
35
35
  address: 816 ahmadu bello way central business district abuja,
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::NigeriaNinMatch2DateOfBirthField
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::NigeriaNinMatch2DateOfBirthField.new(
16
+ input_value: Wed Jan 31 00:00:00 UTC 1990,
17
+ outcome: Partial Match
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::NigeriaNinMatch2FullNameField
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::NigeriaNinMatch2FullNameField.new(
16
+ input_value: MUSA IBRAHIM MOHAMMED,
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 Nigerian National ID number (NIN) | [optional] |
7
+ | **id_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment. Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm | [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] |
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::NigeriaNinMatch2NationalIdNumberField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment. Format: - 11 numeric digits - No personal information is encoded in the NIN | |
8
+ | **outcome** | **String** | The outcome of verifying the NIN against the National Identity 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::NigeriaNinMatch2NationalIdNumberField.new(
16
+ input_value: 12345678902,
17
+ outcome: Verified
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::NigeriaNinMatch2PhoneNumberField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_value** | **String** | The phone number as submitted for this check. Format: - International E.164 | |
8
+ | **outcome** | **String** | The outcome of comparing the submitted phone number 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::NigeriaNinMatch2PhoneNumberField.new(
16
+ input_value: +2340123456789,
17
+ outcome: Exact Match
18
+ )
19
+ ```
20
+