trinsic_api 3.2.1 → 3.3.0.pre.alpha2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. checksums.yaml +4 -4
  2. data/docs/BrazilCnhProviderOutput.md +2 -0
  3. data/docs/BrazilCpfCheckInput.md +3 -3
  4. data/docs/BrazilCpfProviderOutput.md +1 -1
  5. data/docs/BrazilDigitalCnhInput.md +1 -1
  6. data/docs/ConnectIdAgeVerification.md +9 -1
  7. data/docs/ConnectIdInput.md +18 -0
  8. data/docs/CreateDirectProviderSessionRequest.md +2 -0
  9. data/docs/CreateHostedProviderSessionRequest.md +2 -0
  10. data/docs/CzechBankIdInput.md +18 -0
  11. data/docs/DeveloperApi.md +153 -0
  12. data/docs/DigilockerAadhaarProviderOutput.md +1 -1
  13. data/docs/FinnishTrustNetworkAddressOutput.md +22 -0
  14. data/docs/FinnishTrustNetworkInput.md +18 -0
  15. data/docs/FinnishTrustNetworkProviderOutput.md +2 -0
  16. data/docs/GetAttachmentResponse.md +2 -0
  17. data/docs/GetSessionResultRequest.md +3 -1
  18. data/docs/GetSessionResultResponse.md +3 -1
  19. data/docs/HPKETestRequest.md +22 -0
  20. data/docs/HPKETestVPRequest.md +20 -0
  21. data/docs/IdemiaMobileIdProviderOutput.md +1 -5
  22. data/docs/IndiaPanLookupProviderOutput.md +1 -1
  23. data/docs/IndonesiaDukcapilMatchInput.md +1 -1
  24. data/docs/JapanMyNumberProviderOutput.md +24 -0
  25. data/docs/JordanSanadInput.md +18 -0
  26. data/docs/MitIdAddressOutput.md +28 -0
  27. data/docs/MitIdProviderOutput.md +3 -1
  28. data/docs/PolandMobywatelMatchInput.md +1 -1
  29. data/docs/Provider.md +2 -0
  30. data/docs/ProviderInput.md +10 -0
  31. data/docs/ProviderOutput.md +8 -0
  32. data/docs/RecommendProviderInformation.md +2 -0
  33. data/docs/RecommendProvidersRequest.md +1 -1
  34. data/docs/RevolutProviderOutput.md +28 -0
  35. data/docs/SanadProviderOutput.md +28 -0
  36. data/docs/SaudiArabiaNafathAddress.md +50 -0
  37. data/docs/SaudiArabiaNafathCitizenAttributes.md +68 -0
  38. data/docs/SaudiArabiaNafathHeadOfHousehold.md +26 -0
  39. data/docs/SaudiArabiaNafathProviderOutput.md +38 -0
  40. data/docs/SaudiArabiaNafathResidentAttributes.md +68 -0
  41. data/docs/SaudiArabiaNafathVisitorAttributes.md +72 -0
  42. data/docs/SessionsApi.md +2 -2
  43. data/docs/SignzyIndiaAadhaarFetchProviderOutput.md +1 -1
  44. data/docs/SingpassPersonalCatalog.md +2 -2
  45. data/docs/SwedenBankIdProviderOutput.md +7 -3
  46. data/docs/TrinsicHPKEBundle.md +24 -0
  47. data/docs/TrinsicHPKEMetadata.md +30 -0
  48. data/docs/TrinsicTestDatabaseLookupInput.md +1 -1
  49. data/docs/UkEvisaLookupInput.md +1 -1
  50. data/docs/UsaArizonaWalletInput.md +18 -0
  51. data/docs/VerificationProfileResponse.md +2 -0
  52. data/docs/VerificationProfilesApi.md +3 -1
  53. data/docs/YotiStructuredPostalAddress.md +1 -1
  54. data/lib/trinsic_api/api/developer_api.rb +156 -0
  55. data/lib/trinsic_api/api/verification_profiles_api.rb +3 -0
  56. data/lib/trinsic_api/api_client.rb +1 -0
  57. data/lib/trinsic_api/models/brazil_cnh_provider_output.rb +12 -1
  58. data/lib/trinsic_api/models/brazil_cpf_check_input.rb +12 -22
  59. data/lib/trinsic_api/models/brazil_cpf_provider_output.rb +1 -1
  60. data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +1 -1
  61. data/lib/trinsic_api/models/connect_id_age_verification.rb +46 -2
  62. data/lib/trinsic_api/models/connect_id_input.rb +149 -0
  63. data/lib/trinsic_api/models/create_direct_provider_session_request.rb +28 -1
  64. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +28 -1
  65. data/lib/trinsic_api/models/czech_bank_id_input.rb +149 -0
  66. data/lib/trinsic_api/models/digilocker_aadhaar_provider_output.rb +1 -1
  67. data/lib/trinsic_api/models/finnish_trust_network_address_output.rb +171 -0
  68. data/lib/trinsic_api/models/finnish_trust_network_input.rb +149 -0
  69. data/lib/trinsic_api/models/finnish_trust_network_provider_output.rb +12 -1
  70. data/lib/trinsic_api/models/get_attachment_response.rb +12 -1
  71. data/lib/trinsic_api/models/get_session_result_request.rb +15 -4
  72. data/lib/trinsic_api/models/get_session_result_response.rb +16 -5
  73. data/lib/trinsic_api/models/hpke_test_request.rb +219 -0
  74. data/lib/trinsic_api/models/hpke_test_vp_request.rb +192 -0
  75. data/lib/trinsic_api/models/idemia_mobile_id_provider_output.rb +1 -23
  76. data/lib/trinsic_api/models/india_pan_lookup_provider_output.rb +1 -1
  77. data/lib/trinsic_api/models/indonesia_dukcapil_match_input.rb +1 -1
  78. data/lib/trinsic_api/models/japan_my_number_provider_output.rb +183 -0
  79. data/lib/trinsic_api/models/jordan_sanad_input.rb +164 -0
  80. data/lib/trinsic_api/models/mit_id_address_output.rb +204 -0
  81. data/lib/trinsic_api/models/mit_id_provider_output.rb +16 -5
  82. data/lib/trinsic_api/models/poland_mobywatel_match_input.rb +1 -1
  83. data/lib/trinsic_api/models/provider.rb +14 -1
  84. data/lib/trinsic_api/models/provider_input.rb +56 -1
  85. data/lib/trinsic_api/models/provider_output.rb +45 -1
  86. data/lib/trinsic_api/models/recommend_provider_information.rb +14 -1
  87. data/lib/trinsic_api/models/recommend_providers_request.rb +1 -1
  88. data/lib/trinsic_api/models/revolut_provider_output.rb +204 -0
  89. data/lib/trinsic_api/models/sanad_provider_output.rb +205 -0
  90. data/lib/trinsic_api/models/saudi_arabia_nafath_address.rb +325 -0
  91. data/lib/trinsic_api/models/saudi_arabia_nafath_citizen_attributes.rb +426 -0
  92. data/lib/trinsic_api/models/saudi_arabia_nafath_head_of_household.rb +193 -0
  93. data/lib/trinsic_api/models/saudi_arabia_nafath_provider_output.rb +260 -0
  94. data/lib/trinsic_api/models/saudi_arabia_nafath_resident_attributes.rb +426 -0
  95. data/lib/trinsic_api/models/saudi_arabia_nafath_visitor_attributes.rb +446 -0
  96. data/lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb +1 -1
  97. data/lib/trinsic_api/models/singpass_personal_catalog.rb +9 -9
  98. data/lib/trinsic_api/models/sweden_bank_id_provider_output.rb +24 -2
  99. data/lib/trinsic_api/models/trinsic_hpke_bundle.rb +246 -0
  100. data/lib/trinsic_api/models/trinsic_hpke_metadata.rb +327 -0
  101. data/lib/trinsic_api/models/trinsic_test_database_lookup_input.rb +1 -1
  102. data/lib/trinsic_api/models/uk_evisa_lookup_input.rb +1 -1
  103. data/lib/trinsic_api/models/usa_arizona_wallet_input.rb +149 -0
  104. data/lib/trinsic_api/models/verification_profile_response.rb +28 -1
  105. data/lib/trinsic_api/version.rb +1 -1
  106. data/lib/trinsic_api.rb +21 -0
  107. data/spec/api/developer_api_spec.rb +60 -0
  108. data/spec/api/verification_profiles_api_spec.rb +1 -0
  109. data/spec/models/brazil_cnh_provider_output_spec.rb +6 -0
  110. data/spec/models/connect_id_age_verification_spec.rb +24 -0
  111. data/spec/models/connect_id_input_spec.rb +36 -0
  112. data/spec/models/create_direct_provider_session_request_spec.rb +6 -0
  113. data/spec/models/create_hosted_provider_session_request_spec.rb +6 -0
  114. data/spec/models/czech_bank_id_input_spec.rb +36 -0
  115. data/spec/models/finnish_trust_network_address_output_spec.rb +48 -0
  116. data/spec/models/finnish_trust_network_input_spec.rb +36 -0
  117. data/spec/models/finnish_trust_network_provider_output_spec.rb +6 -0
  118. data/spec/models/get_attachment_response_spec.rb +6 -0
  119. data/spec/models/get_session_result_request_spec.rb +6 -0
  120. data/spec/models/get_session_result_response_spec.rb +6 -0
  121. data/spec/models/hpke_test_request_spec.rb +48 -0
  122. data/spec/models/hpke_test_vp_request_spec.rb +42 -0
  123. data/spec/models/idemia_mobile_id_provider_output_spec.rb +0 -12
  124. data/spec/models/japan_my_number_provider_output_spec.rb +54 -0
  125. data/spec/models/jordan_sanad_input_spec.rb +36 -0
  126. data/spec/models/mit_id_address_output_spec.rb +66 -0
  127. data/spec/models/mit_id_provider_output_spec.rb +6 -0
  128. data/spec/models/provider_input_spec.rb +30 -0
  129. data/spec/models/provider_output_spec.rb +24 -0
  130. data/spec/models/provider_spec.rb +6 -0
  131. data/spec/models/recommend_provider_information_spec.rb +6 -0
  132. data/spec/models/revolut_provider_output_spec.rb +66 -0
  133. data/spec/models/sanad_provider_output_spec.rb +66 -0
  134. data/spec/models/saudi_arabia_nafath_address_spec.rb +132 -0
  135. data/spec/models/saudi_arabia_nafath_citizen_attributes_spec.rb +186 -0
  136. data/spec/models/saudi_arabia_nafath_head_of_household_spec.rb +60 -0
  137. data/spec/models/saudi_arabia_nafath_provider_output_spec.rb +96 -0
  138. data/spec/models/saudi_arabia_nafath_resident_attributes_spec.rb +186 -0
  139. data/spec/models/saudi_arabia_nafath_visitor_attributes_spec.rb +198 -0
  140. data/spec/models/singpass_personal_catalog_spec.rb +1 -1
  141. data/spec/models/sweden_bank_id_provider_output_spec.rb +12 -0
  142. data/spec/models/trinsic_hpke_bundle_spec.rb +54 -0
  143. data/spec/models/trinsic_hpke_metadata_spec.rb +72 -0
  144. data/spec/models/usa_arizona_wallet_input_spec.rb +36 -0
  145. data/spec/models/verification_profile_response_spec.rb +6 -0
  146. metadata +375 -291
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::TrinsicHPKEBundle
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trinsic_hpke_version** | **Integer** | The version of the Trinsic HPKE Exchange Protocol in use. Always `1` at this time. | |
8
+ | **metadata** | [**TrinsicHPKEMetadata**](TrinsicHPKEMetadata.md) | Information about the HPKE parameters in use. Trinsic currently supports a fixed set of HPKE parameters: - Mode: Basic - KEM: DHKEM(P256, HKDF-SHA256) - KDF: HKDF-SHA256 - AEAD: AES-128-GCM | |
9
+ | **ephemeral_sender_public_key** | **String** | Corresponds to the `enc` parameter of HPKE. The raw bytes, in a format unique to the chosen HPKE KEM, of the ephemeral sender public key for this single-shot HPKE exchange. Because Trinsic only supports DHKEM(P256, HKDF-SHA256), this is always a 65-byte array with the following format: [0x04][XCoord][YCoord] Where [0x04] is a single byte with value `4`, and [XCoord] / [YCoord] are each 32-byte X/Y coordinates of a P-256 public key. | |
10
+ | **ciphertext** | **String** | Corresponds to the `ct` parameter of HPKE. The encrypted ciphertext for this HPKE single-shot message. Because Trinsic only supports AES-128-GCM, this byte array always has an exact format: [CipherText][Tag] Where [ciphertext] is a variable-length array of bytes, and [tag] is a 16-length byte array. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::TrinsicHPKEBundle.new(
18
+ trinsic_hpke_version: null,
19
+ metadata: null,
20
+ ephemeral_sender_public_key: null,
21
+ ciphertext: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,30 @@
1
+ # TrinsicApi::TrinsicHPKEMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mode** | **Integer** | The HPKE mode in use. Trinsic only currently supports the Basic mode. There are four modes defined in the HPKE specification: - Basic (0): Sender is not authenticated - PSK (1): Sender is authenticated by proving possession of a Pre-Shared Key (byte array) which the recipient also knows. - Auth (2): Sender is authenticated by proving possession of a Private Key, for which the recipient knows the corresponding Public Key. - AuthPSK (3): Sender is authenticated by proving possession of both a Pre-Shared Key and a Private Key. | |
8
+ | **kem** | **Integer** | The Key Encapsulation Mechanism (KEM) used for the HPKE handshake. Trinsic currently only supports the DHKEM(P256, HKDF-SHA256) KEM, meaning that only P-256 keys are supported. | |
9
+ | **kdf** | **Integer** | The Key Derivation Function (KDF) used for the HPKE handshake. Trinsic currently only supports HKDF-SHA256. | |
10
+ | **aead** | **Integer** | The symmetric encryption cipher used for ciphertext encryption and decryption. Trinsic currently only supports AES-128-GCM. | |
11
+ | **info_hash** | **String** | SHA-256 hash of the `info` parameter used during HPKE encryption. This is not used in HPKE directly. This is provided as a helper for debugging and development purposes, to verify that the same `info` hash is being used by both Trinsic and your integration. | |
12
+ | **recipient_public_key_hash** | **String** | SHA-256 hash of the recipient's P-256 public key in raw uncompressed point encoding ([0x04][X][Y]). This is not used in HPKE directly. Use this to verify that an HPKE message was encrypted against your public key, and/or to identify which of your keys a message was encrypted against, before proceeding with decryption. This and `recipientPublicKeyJwkThumbprint` are both effectively hashes of the recipient's (your) public key. Either is appropriate to use for the same purpose. | |
13
+ | **recipient_public_key_jwk_thumbprint** | **String** | JWK Thumbprint of the recipient's P-256 public key, in base64url encoding. This is not used in HPKE directly. Use this to verify that an HPKE message was encrypted against your public key, and/or to identify which of your keys a message was encrypted against, before proceeding with decryption. This and `recipientPublicKeyHash` are both effectively hashes of the recipient's (your) public key. Either is appropriate to use for the same purpose. | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'trinsic_api'
19
+
20
+ instance = TrinsicApi::TrinsicHPKEMetadata.new(
21
+ mode: null,
22
+ kem: null,
23
+ kdf: null,
24
+ aead: null,
25
+ info_hash: null,
26
+ recipient_public_key_hash: null,
27
+ recipient_public_key_jwk_thumbprint: null
28
+ )
29
+ ```
30
+
@@ -7,7 +7,7 @@
7
7
  | **given_name** | **String** | The given name to use for the output of the test Session. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Can be any non-empty value. | [optional] |
8
8
  | **family_name** | **String** | The family name to use for the output of the test Session. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Can be any non-empty value. | [optional] |
9
9
  | **identity_code** | **String** | A 6-digit code; must be \"123456\" for the Session to succeed. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Any other value will cause the Session to fail. | [optional] |
10
- | **selfie_base64** | **String** | An optional selfie image, base64-encoded. Will replace the existing test selfie attachment output if provided. | [optional] |
10
+ | **selfie_base64** | **String** | An optional selfie image in a Base64 string. Will replace the existing test selfie attachment output if provided. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **share_code** | **String** | The 9-character share code. | |
7
+ | **share_code** | **String** | The 9-character alphanumeric UK Visas and Immigration (UKVI) share code. Must start with W for right to work, R for right to rent, or S for immigration status, matching the configured lookup type. Whitespace is removed and lowercase ASCII letters are converted to uppercase. | |
8
8
  | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format. | |
9
9
 
10
10
  ## Example
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::UsaArizonaWalletInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | The raw 18013-7 exchange request to use for this verification. If set, this overrides any default configuration on your Verification Profile. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::UsaArizonaWalletInput.new(
15
+ preview_raw18013_request: null
16
+ )
17
+ ```
18
+
@@ -8,6 +8,7 @@
8
8
  | **_alias** | **String** | An alias of the verification profile shown to developers and administrators. | |
9
9
  | **brand_name** | **String** | The brand name of the verification profile shown to end-users. | |
10
10
  | **external_id** | **String** | A customer-defined external ID for this verification profile, unique within your organization. | [optional] |
11
+ | **geography** | **String** | The data-residency geography of the verification profile, such as \"US\" or \"EU\". | |
11
12
  | **logo_url** | **String** | The URL of the verification profile's logo. | |
12
13
  | **primary_color** | **String** | The primary color of the verification profile. | |
13
14
  | **enabled_providers** | **Array<String>** | The providers that are currently enabled for the verification profile. | |
@@ -24,6 +25,7 @@ instance = TrinsicApi::VerificationProfileResponse.new(
24
25
  _alias: null,
25
26
  brand_name: null,
26
27
  external_id: null,
28
+ geography: US,
27
29
  logo_url: null,
28
30
  primary_color: null,
29
31
  enabled_providers: null,
@@ -257,7 +257,8 @@ end
257
257
  api_instance = TrinsicApi::VerificationProfilesApi.new
258
258
  opts = {
259
259
  page: 56, # Integer |
260
- page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
260
+ page_size: 56, # Integer | Size of the list to be returned. Accepted range from 1 to 100
261
+ geography: 'geography_example' # String | Filter by data-residency geography. Accepted values: \"US\", \"EU\" (case-insensitive). Omit to include all geographies.
261
262
  }
262
263
 
263
264
  begin
@@ -293,6 +294,7 @@ end
293
294
  | ---- | ---- | ----------- | ----- |
294
295
  | **page** | **Integer** | | [optional][default to 1] |
295
296
  | **page_size** | **Integer** | Size of the list to be returned. Accepted range from 1 to 100 | [optional][default to 20] |
297
+ | **geography** | **String** | Filter by data-residency geography. Accepted values: \"US\", \"EU\" (case-insensitive). Omit to include all geographies. | [optional] |
296
298
 
297
299
  ### Return type
298
300
 
@@ -31,7 +31,7 @@
31
31
  require 'trinsic_api'
32
32
 
33
33
  instance = TrinsicApi::YotiStructuredPostalAddress.new(
34
- country: UK,
34
+ country: GB,
35
35
  country_iso: USA,
36
36
  formatted_address: 15a North Street\nCARSHALTON\nSM5 2HW\nUK,
37
37
  line1: 15a North Street,
@@ -0,0 +1,156 @@
1
+ =begin
2
+ #Trinsic API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v1
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.21.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module TrinsicApi
16
+ class DeveloperApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Test HPKE Against Arbitrary Key
23
+ # Encrypts the provided data against the given public key using HPKE, and returns the resulting bundle. This is intended for integration testing and development purposes.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [HPKETestRequest] :hpke_test_request
26
+ # @return [TrinsicHPKEBundle]
27
+ def test_against_arbitrary_key(opts = {})
28
+ data, _status_code, _headers = test_against_arbitrary_key_with_http_info(opts)
29
+ data
30
+ end
31
+
32
+ # Test HPKE Against Arbitrary Key
33
+ # Encrypts the provided data against the given public key using HPKE, and returns the resulting bundle. This is intended for integration testing and development purposes.
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [HPKETestRequest] :hpke_test_request
36
+ # @return [Array<(TrinsicHPKEBundle, Integer, Hash)>] TrinsicHPKEBundle data, response status code and response headers
37
+ def test_against_arbitrary_key_with_http_info(opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: DeveloperApi.test_against_arbitrary_key ...'
40
+ end
41
+ # resource path
42
+ local_var_path = '/api/v1/developer/hpke-test'
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+
47
+ # header parameters
48
+ header_params = opts[:header_params] || {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
51
+ # HTTP header 'Content-Type'
52
+ content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
53
+ if !content_type.nil?
54
+ header_params['Content-Type'] = content_type
55
+ end
56
+
57
+ # form parameters
58
+ form_params = opts[:form_params] || {}
59
+
60
+ # http body (model)
61
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'hpke_test_request'])
62
+
63
+ # return_type
64
+ return_type = opts[:debug_return_type] || 'TrinsicHPKEBundle'
65
+
66
+ # auth_names
67
+ auth_names = opts[:debug_auth_names] || ['Bearer']
68
+
69
+ new_options = opts.merge(
70
+ :operation => :"DeveloperApi.test_against_arbitrary_key",
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: DeveloperApi#test_against_arbitrary_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Test HPKE Against Verification Profile Key
87
+ # Encrypts the provided data against the PII encryption key configured on the given verification profile. This is intended for integration testing and development purposes.
88
+ # @param verification_profile_id [String]
89
+ # @param [Hash] opts the optional parameters
90
+ # @option opts [HPKETestVPRequest] :hpke_test_vp_request
91
+ # @return [TrinsicHPKEBundle]
92
+ def test_against_verification_profile(verification_profile_id, opts = {})
93
+ data, _status_code, _headers = test_against_verification_profile_with_http_info(verification_profile_id, opts)
94
+ data
95
+ end
96
+
97
+ # Test HPKE Against Verification Profile Key
98
+ # Encrypts the provided data against the PII encryption key configured on the given verification profile. This is intended for integration testing and development purposes.
99
+ # @param verification_profile_id [String]
100
+ # @param [Hash] opts the optional parameters
101
+ # @option opts [HPKETestVPRequest] :hpke_test_vp_request
102
+ # @return [Array<(TrinsicHPKEBundle, Integer, Hash)>] TrinsicHPKEBundle data, response status code and response headers
103
+ def test_against_verification_profile_with_http_info(verification_profile_id, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: DeveloperApi.test_against_verification_profile ...'
106
+ end
107
+ # verify the required parameter 'verification_profile_id' is set
108
+ if @api_client.config.client_side_validation && verification_profile_id.nil?
109
+ fail ArgumentError, "Missing the required parameter 'verification_profile_id' when calling DeveloperApi.test_against_verification_profile"
110
+ end
111
+ # resource path
112
+ local_var_path = '/api/v1/developer/hpke-test/{verificationProfileId}'.sub('{' + 'verificationProfileId' + '}', CGI.escape(verification_profile_id.to_s))
113
+
114
+ # query parameters
115
+ query_params = opts[:query_params] || {}
116
+
117
+ # header parameters
118
+ header_params = opts[:header_params] || {}
119
+ # HTTP header 'Accept' (if needed)
120
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
121
+ # HTTP header 'Content-Type'
122
+ content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
123
+ if !content_type.nil?
124
+ header_params['Content-Type'] = content_type
125
+ end
126
+
127
+ # form parameters
128
+ form_params = opts[:form_params] || {}
129
+
130
+ # http body (model)
131
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'hpke_test_vp_request'])
132
+
133
+ # return_type
134
+ return_type = opts[:debug_return_type] || 'TrinsicHPKEBundle'
135
+
136
+ # auth_names
137
+ auth_names = opts[:debug_auth_names] || ['Bearer']
138
+
139
+ new_options = opts.merge(
140
+ :operation => :"DeveloperApi.test_against_verification_profile",
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: DeveloperApi#test_against_verification_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+ end
156
+ end
@@ -275,6 +275,7 @@ module TrinsicApi
275
275
  # @param [Hash] opts the optional parameters
276
276
  # @option opts [Integer] :page (default to 1)
277
277
  # @option opts [Integer] :page_size Size of the list to be returned. Accepted range from 1 to 100 (default to 20)
278
+ # @option opts [String] :geography Filter by data-residency geography. Accepted values: \&quot;US\&quot;, \&quot;EU\&quot; (case-insensitive). Omit to include all geographies.
278
279
  # @return [ListVerificationProfilesResponse]
279
280
  def list_verification_profiles(opts = {})
280
281
  data, _status_code, _headers = list_verification_profiles_with_http_info(opts)
@@ -286,6 +287,7 @@ module TrinsicApi
286
287
  # @param [Hash] opts the optional parameters
287
288
  # @option opts [Integer] :page (default to 1)
288
289
  # @option opts [Integer] :page_size Size of the list to be returned. Accepted range from 1 to 100 (default to 20)
290
+ # @option opts [String] :geography Filter by data-residency geography. Accepted values: \&quot;US\&quot;, \&quot;EU\&quot; (case-insensitive). Omit to include all geographies.
289
291
  # @return [Array<(ListVerificationProfilesResponse, Integer, Hash)>] ListVerificationProfilesResponse data, response status code and response headers
290
292
  def list_verification_profiles_with_http_info(opts = {})
291
293
  if @api_client.config.debugging
@@ -314,6 +316,7 @@ module TrinsicApi
314
316
  query_params = opts[:query_params] || {}
315
317
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
316
318
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
319
+ query_params[:'geography'] = opts[:'geography'] if !opts[:'geography'].nil?
317
320
 
318
321
  # header parameters
319
322
  header_params = opts[:header_params] || {}
@@ -96,6 +96,7 @@ module TrinsicApi
96
96
  http_method = http_method.to_sym.downcase
97
97
 
98
98
  header_params = @default_headers.merge(opts[:header_params] || {})
99
+ header_params['X-Trinsic-SDK'] = "ruby/3.3.0-alpha2"
99
100
  query_params = opts[:query_params] || {}
100
101
  form_params = opts[:form_params] || {}
101
102
  follow_location = opts[:follow_location] || true
@@ -16,6 +16,9 @@ require 'time'
16
16
  module TrinsicApi
17
17
  # Exposed properties for the `brazil-digital-cnh` Provider which do not directly map to the normalized IdentityData model.
18
18
  class BrazilCnhProviderOutput < ApiModelBase
19
+ # The individual's CPF number. A CPF (Cadastro de Pessoas Físicas) is the Brazilian individual taxpayer identification number for residents and foreigners. It is an 11-digit number managed by the Federal Revenue Service, the last 2 digits are check digits, calculated based on the first 9 digits. The 9th digit indicates the fiscal region responsible for the registration,
20
+ attr_accessor :cpf_number
21
+
19
22
  # Full name decoded from the CNH QR Code and whether it matched the government database.
20
23
  attr_accessor :full_name
21
24
 
@@ -67,6 +70,7 @@ module TrinsicApi
67
70
  # Attribute mapping from ruby-style variable name to JSON key.
68
71
  def self.attribute_map
69
72
  {
73
+ :'cpf_number' => :'cpfNumber',
70
74
  :'full_name' => :'fullName',
71
75
  :'full_name_similarity' => :'fullNameSimilarity',
72
76
  :'origin_document' => :'originDocument',
@@ -99,6 +103,7 @@ module TrinsicApi
99
103
  # Attribute type mapping.
100
104
  def self.openapi_types
101
105
  {
106
+ :'cpf_number' => :'String',
102
107
  :'full_name' => :'BrazilCnhMatchFieldString',
103
108
  :'full_name_similarity' => :'Float',
104
109
  :'origin_document' => :'String',
@@ -121,6 +126,7 @@ module TrinsicApi
121
126
  # List of attributes with nullable: true
122
127
  def self.openapi_nullable
123
128
  Set.new([
129
+ :'cpf_number',
124
130
  :'full_name',
125
131
  :'full_name_similarity',
126
132
  :'origin_document',
@@ -156,6 +162,10 @@ module TrinsicApi
156
162
  h[k.to_sym] = v
157
163
  }
158
164
 
165
+ if attributes.key?(:'cpf_number')
166
+ self.cpf_number = attributes[:'cpf_number']
167
+ end
168
+
159
169
  if attributes.key?(:'full_name')
160
170
  self.full_name = attributes[:'full_name']
161
171
  end
@@ -241,6 +251,7 @@ module TrinsicApi
241
251
  def ==(o)
242
252
  return true if self.equal?(o)
243
253
  self.class == o.class &&
254
+ cpf_number == o.cpf_number &&
244
255
  full_name == o.full_name &&
245
256
  full_name_similarity == o.full_name_similarity &&
246
257
  origin_document == o.origin_document &&
@@ -268,7 +279,7 @@ module TrinsicApi
268
279
  # Calculates hash code according to all attributes.
269
280
  # @return [Integer] Hash code
270
281
  def hash
271
- [full_name, full_name_similarity, origin_document, date_of_birth, mother_full_name, father_full_name, category, registration_number, registration_number_check_digits_valid, first_issue_date, observations, issue_city, issue_state, validation_number, renach_number, facial_biometry].hash
282
+ [cpf_number, full_name, full_name_similarity, origin_document, date_of_birth, mother_full_name, father_full_name, category, registration_number, registration_number_check_digits_valid, first_issue_date, observations, issue_city, issue_state, validation_number, renach_number, facial_biometry].hash
272
283
  end
273
284
 
274
285
  # Builds the object from hash
@@ -18,10 +18,10 @@ module TrinsicApi
18
18
  # The user's 11-digit, numeric CPF Number
19
19
  attr_accessor :cpf_number
20
20
 
21
- # The user's date of birth. Optional, but date of birth will become required for lookups starting September 1, 2026.
21
+ # The user's date of birth, in `YYYY-MM-DD` format. Optional in this request; required to complete CPF lookups.
22
22
  attr_accessor :date_of_birth
23
23
 
24
- # The raw bytes of the selfie image collected from the user.
24
+ # The selfie image collected from the user. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64.
25
25
  attr_accessor :selfie_image
26
26
 
27
27
  # The MIME Type of the file contained in `SelfieImage`. Must be one of `image/jpeg` or `image/png`.
@@ -60,6 +60,7 @@ module TrinsicApi
60
60
  # List of attributes with nullable: true
61
61
  def self.openapi_nullable
62
62
  Set.new([
63
+ :'cpf_number',
63
64
  :'date_of_birth',
64
65
  :'selfie_image',
65
66
  :'selfie_image_content_type'
@@ -84,8 +85,6 @@ module TrinsicApi
84
85
 
85
86
  if attributes.key?(:'cpf_number')
86
87
  self.cpf_number = attributes[:'cpf_number']
87
- else
88
- self.cpf_number = nil
89
88
  end
90
89
 
91
90
  if attributes.key?(:'date_of_birth')
@@ -106,20 +105,16 @@ module TrinsicApi
106
105
  def list_invalid_properties
107
106
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
108
107
  invalid_properties = Array.new
109
- if @cpf_number.nil?
110
- invalid_properties.push('invalid value for "cpf_number", cpf_number cannot be nil.')
111
- end
112
-
113
- if @cpf_number.to_s.length > 11
108
+ if !@cpf_number.nil? && @cpf_number.to_s.length > 11
114
109
  invalid_properties.push('invalid value for "cpf_number", the character length must be smaller than or equal to 11.')
115
110
  end
116
111
 
117
- if @cpf_number.to_s.length < 11
112
+ if !@cpf_number.nil? && @cpf_number.to_s.length < 11
118
113
  invalid_properties.push('invalid value for "cpf_number", the character length must be greater than or equal to 11.')
119
114
  end
120
115
 
121
116
  pattern = Regexp.new(/^\d*$/)
122
- if @cpf_number !~ pattern
117
+ if !@cpf_number.nil? && @cpf_number !~ pattern
123
118
  invalid_properties.push("invalid value for \"cpf_number\", must conform to the pattern #{pattern}.")
124
119
  end
125
120
 
@@ -130,30 +125,25 @@ module TrinsicApi
130
125
  # @return true if the model is valid
131
126
  def valid?
132
127
  warn '[DEPRECATED] the `valid?` method is obsolete'
133
- return false if @cpf_number.nil?
134
- return false if @cpf_number.to_s.length > 11
135
- return false if @cpf_number.to_s.length < 11
136
- return false if @cpf_number !~ Regexp.new(/^\d*$/)
128
+ return false if !@cpf_number.nil? && @cpf_number.to_s.length > 11
129
+ return false if !@cpf_number.nil? && @cpf_number.to_s.length < 11
130
+ return false if !@cpf_number.nil? && @cpf_number !~ Regexp.new(/^\d*$/)
137
131
  true
138
132
  end
139
133
 
140
134
  # Custom attribute writer method with validation
141
135
  # @param [Object] cpf_number Value to be assigned
142
136
  def cpf_number=(cpf_number)
143
- if cpf_number.nil?
144
- fail ArgumentError, 'cpf_number cannot be nil'
145
- end
146
-
147
- if cpf_number.to_s.length > 11
137
+ if !cpf_number.nil? && cpf_number.to_s.length > 11
148
138
  fail ArgumentError, 'invalid value for "cpf_number", the character length must be smaller than or equal to 11.'
149
139
  end
150
140
 
151
- if cpf_number.to_s.length < 11
141
+ if !cpf_number.nil? && cpf_number.to_s.length < 11
152
142
  fail ArgumentError, 'invalid value for "cpf_number", the character length must be greater than or equal to 11.'
153
143
  end
154
144
 
155
145
  pattern = Regexp.new(/^\d*$/)
156
- if cpf_number !~ pattern
146
+ if !cpf_number.nil? && cpf_number !~ pattern
157
147
  fail ArgumentError, "invalid value for \"cpf_number\", must conform to the pattern #{pattern}."
158
148
  end
159
149
 
@@ -40,7 +40,7 @@ module TrinsicApi
40
40
  # The date of birth of the individual.
41
41
  attr_accessor :date_of_birth
42
42
 
43
- # Deprecated as of September 1, 2026. The year of death of the individual, if applicable.
43
+ # Deprecated as of September 19, 2026. The year of death of the individual, if applicable.
44
44
  attr_accessor :year_of_death
45
45
 
46
46
  # The date of registration of the individual with the Federal Revenue Service.
@@ -24,7 +24,7 @@ module TrinsicApi
24
24
  # The MIME Type of the file contained in `DigitalCnhFile`. Must be one of `application/pdf`, `image/jpeg`, or `image/png`.
25
25
  attr_accessor :digital_cnh_file_content_type
26
26
 
27
- # The raw bytes of the image of the user's face, collected for biometric comparison.
27
+ # The raw bytes of the image of the user's face, collected for biometric comparison. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64.
28
28
  attr_accessor :facial_biometry_photo
29
29
 
30
30
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -15,16 +15,32 @@ require 'time'
15
15
 
16
16
  module TrinsicApi
17
17
  class ConnectIdAgeVerification < ApiModelBase
18
- # If the individual is over 18 years old.
18
+ # Whether the individual is at least 16 years old.
19
+ attr_accessor :over16
20
+
21
+ # Whether the individual is at least 18 years old.
19
22
  attr_accessor :over18
20
23
 
24
+ # Whether the individual is at least 21 years old.
25
+ attr_accessor :over21
26
+
27
+ # Whether the individual is at least 25 years old.
28
+ attr_accessor :over25
29
+
30
+ # Whether the individual is at least 65 years old.
31
+ attr_accessor :over65
32
+
21
33
  # The authority that verified the claim.
22
34
  attr_accessor :trust_framework
23
35
 
24
36
  # Attribute mapping from ruby-style variable name to JSON key.
25
37
  def self.attribute_map
26
38
  {
39
+ :'over16' => :'over16',
27
40
  :'over18' => :'over18',
41
+ :'over21' => :'over21',
42
+ :'over25' => :'over25',
43
+ :'over65' => :'over65',
28
44
  :'trust_framework' => :'trustFramework'
29
45
  }
30
46
  end
@@ -42,7 +58,11 @@ module TrinsicApi
42
58
  # Attribute type mapping.
43
59
  def self.openapi_types
44
60
  {
61
+ :'over16' => :'Boolean',
45
62
  :'over18' => :'Boolean',
63
+ :'over21' => :'Boolean',
64
+ :'over25' => :'Boolean',
65
+ :'over65' => :'Boolean',
46
66
  :'trust_framework' => :'String'
47
67
  }
48
68
  end
@@ -50,7 +70,11 @@ module TrinsicApi
50
70
  # List of attributes with nullable: true
51
71
  def self.openapi_nullable
52
72
  Set.new([
73
+ :'over16',
53
74
  :'over18',
75
+ :'over21',
76
+ :'over25',
77
+ :'over65',
54
78
  :'trust_framework'
55
79
  ])
56
80
  end
@@ -71,10 +95,26 @@ module TrinsicApi
71
95
  h[k.to_sym] = v
72
96
  }
73
97
 
98
+ if attributes.key?(:'over16')
99
+ self.over16 = attributes[:'over16']
100
+ end
101
+
74
102
  if attributes.key?(:'over18')
75
103
  self.over18 = attributes[:'over18']
76
104
  end
77
105
 
106
+ if attributes.key?(:'over21')
107
+ self.over21 = attributes[:'over21']
108
+ end
109
+
110
+ if attributes.key?(:'over25')
111
+ self.over25 = attributes[:'over25']
112
+ end
113
+
114
+ if attributes.key?(:'over65')
115
+ self.over65 = attributes[:'over65']
116
+ end
117
+
78
118
  if attributes.key?(:'trust_framework')
79
119
  self.trust_framework = attributes[:'trust_framework']
80
120
  end
@@ -100,7 +140,11 @@ module TrinsicApi
100
140
  def ==(o)
101
141
  return true if self.equal?(o)
102
142
  self.class == o.class &&
143
+ over16 == o.over16 &&
103
144
  over18 == o.over18 &&
145
+ over21 == o.over21 &&
146
+ over25 == o.over25 &&
147
+ over65 == o.over65 &&
104
148
  trust_framework == o.trust_framework
105
149
  end
106
150
 
@@ -113,7 +157,7 @@ module TrinsicApi
113
157
  # Calculates hash code according to all attributes.
114
158
  # @return [Integer] Hash code
115
159
  def hash
116
- [over18, trust_framework].hash
160
+ [over16, over18, over21, over25, over65, trust_framework].hash
117
161
  end
118
162
 
119
163
  # Builds the object from hash