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.
- checksums.yaml +4 -4
- data/docs/BrazilCnhProviderOutput.md +2 -0
- data/docs/BrazilCpfCheckInput.md +3 -3
- data/docs/BrazilCpfProviderOutput.md +1 -1
- data/docs/BrazilDigitalCnhInput.md +1 -1
- data/docs/ConnectIdAgeVerification.md +9 -1
- data/docs/ConnectIdInput.md +18 -0
- data/docs/CreateDirectProviderSessionRequest.md +2 -0
- data/docs/CreateHostedProviderSessionRequest.md +2 -0
- data/docs/CzechBankIdInput.md +18 -0
- data/docs/DeveloperApi.md +153 -0
- data/docs/DigilockerAadhaarProviderOutput.md +1 -1
- data/docs/FinnishTrustNetworkAddressOutput.md +22 -0
- data/docs/FinnishTrustNetworkInput.md +18 -0
- data/docs/FinnishTrustNetworkProviderOutput.md +2 -0
- data/docs/GetAttachmentResponse.md +2 -0
- data/docs/GetSessionResultRequest.md +3 -1
- data/docs/GetSessionResultResponse.md +3 -1
- data/docs/HPKETestRequest.md +22 -0
- data/docs/HPKETestVPRequest.md +20 -0
- data/docs/IdemiaMobileIdProviderOutput.md +1 -5
- data/docs/IndiaPanLookupProviderOutput.md +1 -1
- data/docs/IndonesiaDukcapilMatchInput.md +1 -1
- data/docs/JapanMyNumberProviderOutput.md +24 -0
- data/docs/JordanSanadInput.md +18 -0
- data/docs/MitIdAddressOutput.md +28 -0
- data/docs/MitIdProviderOutput.md +3 -1
- data/docs/PolandMobywatelMatchInput.md +1 -1
- data/docs/Provider.md +2 -0
- data/docs/ProviderInput.md +10 -0
- data/docs/ProviderOutput.md +8 -0
- data/docs/RecommendProviderInformation.md +2 -0
- data/docs/RecommendProvidersRequest.md +1 -1
- data/docs/RevolutProviderOutput.md +28 -0
- data/docs/SanadProviderOutput.md +28 -0
- data/docs/SaudiArabiaNafathAddress.md +50 -0
- data/docs/SaudiArabiaNafathCitizenAttributes.md +68 -0
- data/docs/SaudiArabiaNafathHeadOfHousehold.md +26 -0
- data/docs/SaudiArabiaNafathProviderOutput.md +38 -0
- data/docs/SaudiArabiaNafathResidentAttributes.md +68 -0
- data/docs/SaudiArabiaNafathVisitorAttributes.md +72 -0
- data/docs/SessionsApi.md +2 -2
- data/docs/SignzyIndiaAadhaarFetchProviderOutput.md +1 -1
- data/docs/SingpassPersonalCatalog.md +2 -2
- data/docs/SwedenBankIdProviderOutput.md +7 -3
- data/docs/TrinsicHPKEBundle.md +24 -0
- data/docs/TrinsicHPKEMetadata.md +30 -0
- data/docs/TrinsicTestDatabaseLookupInput.md +1 -1
- data/docs/UkEvisaLookupInput.md +1 -1
- data/docs/UsaArizonaWalletInput.md +18 -0
- data/docs/VerificationProfileResponse.md +2 -0
- data/docs/VerificationProfilesApi.md +3 -1
- data/docs/YotiStructuredPostalAddress.md +1 -1
- data/lib/trinsic_api/api/developer_api.rb +156 -0
- data/lib/trinsic_api/api/verification_profiles_api.rb +3 -0
- data/lib/trinsic_api/api_client.rb +1 -0
- data/lib/trinsic_api/models/brazil_cnh_provider_output.rb +12 -1
- data/lib/trinsic_api/models/brazil_cpf_check_input.rb +12 -22
- data/lib/trinsic_api/models/brazil_cpf_provider_output.rb +1 -1
- data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +1 -1
- data/lib/trinsic_api/models/connect_id_age_verification.rb +46 -2
- data/lib/trinsic_api/models/connect_id_input.rb +149 -0
- data/lib/trinsic_api/models/create_direct_provider_session_request.rb +28 -1
- data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +28 -1
- data/lib/trinsic_api/models/czech_bank_id_input.rb +149 -0
- data/lib/trinsic_api/models/digilocker_aadhaar_provider_output.rb +1 -1
- data/lib/trinsic_api/models/finnish_trust_network_address_output.rb +171 -0
- data/lib/trinsic_api/models/finnish_trust_network_input.rb +149 -0
- data/lib/trinsic_api/models/finnish_trust_network_provider_output.rb +12 -1
- data/lib/trinsic_api/models/get_attachment_response.rb +12 -1
- data/lib/trinsic_api/models/get_session_result_request.rb +15 -4
- data/lib/trinsic_api/models/get_session_result_response.rb +16 -5
- data/lib/trinsic_api/models/hpke_test_request.rb +219 -0
- data/lib/trinsic_api/models/hpke_test_vp_request.rb +192 -0
- data/lib/trinsic_api/models/idemia_mobile_id_provider_output.rb +1 -23
- data/lib/trinsic_api/models/india_pan_lookup_provider_output.rb +1 -1
- data/lib/trinsic_api/models/indonesia_dukcapil_match_input.rb +1 -1
- data/lib/trinsic_api/models/japan_my_number_provider_output.rb +183 -0
- data/lib/trinsic_api/models/jordan_sanad_input.rb +164 -0
- data/lib/trinsic_api/models/mit_id_address_output.rb +204 -0
- data/lib/trinsic_api/models/mit_id_provider_output.rb +16 -5
- data/lib/trinsic_api/models/poland_mobywatel_match_input.rb +1 -1
- data/lib/trinsic_api/models/provider.rb +14 -1
- data/lib/trinsic_api/models/provider_input.rb +56 -1
- data/lib/trinsic_api/models/provider_output.rb +45 -1
- data/lib/trinsic_api/models/recommend_provider_information.rb +14 -1
- data/lib/trinsic_api/models/recommend_providers_request.rb +1 -1
- data/lib/trinsic_api/models/revolut_provider_output.rb +204 -0
- data/lib/trinsic_api/models/sanad_provider_output.rb +205 -0
- data/lib/trinsic_api/models/saudi_arabia_nafath_address.rb +325 -0
- data/lib/trinsic_api/models/saudi_arabia_nafath_citizen_attributes.rb +426 -0
- data/lib/trinsic_api/models/saudi_arabia_nafath_head_of_household.rb +193 -0
- data/lib/trinsic_api/models/saudi_arabia_nafath_provider_output.rb +260 -0
- data/lib/trinsic_api/models/saudi_arabia_nafath_resident_attributes.rb +426 -0
- data/lib/trinsic_api/models/saudi_arabia_nafath_visitor_attributes.rb +446 -0
- data/lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb +1 -1
- data/lib/trinsic_api/models/singpass_personal_catalog.rb +9 -9
- data/lib/trinsic_api/models/sweden_bank_id_provider_output.rb +24 -2
- data/lib/trinsic_api/models/trinsic_hpke_bundle.rb +246 -0
- data/lib/trinsic_api/models/trinsic_hpke_metadata.rb +327 -0
- data/lib/trinsic_api/models/trinsic_test_database_lookup_input.rb +1 -1
- data/lib/trinsic_api/models/uk_evisa_lookup_input.rb +1 -1
- data/lib/trinsic_api/models/usa_arizona_wallet_input.rb +149 -0
- data/lib/trinsic_api/models/verification_profile_response.rb +28 -1
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +21 -0
- data/spec/api/developer_api_spec.rb +60 -0
- data/spec/api/verification_profiles_api_spec.rb +1 -0
- data/spec/models/brazil_cnh_provider_output_spec.rb +6 -0
- data/spec/models/connect_id_age_verification_spec.rb +24 -0
- data/spec/models/connect_id_input_spec.rb +36 -0
- data/spec/models/create_direct_provider_session_request_spec.rb +6 -0
- data/spec/models/create_hosted_provider_session_request_spec.rb +6 -0
- data/spec/models/czech_bank_id_input_spec.rb +36 -0
- data/spec/models/finnish_trust_network_address_output_spec.rb +48 -0
- data/spec/models/finnish_trust_network_input_spec.rb +36 -0
- data/spec/models/finnish_trust_network_provider_output_spec.rb +6 -0
- data/spec/models/get_attachment_response_spec.rb +6 -0
- data/spec/models/get_session_result_request_spec.rb +6 -0
- data/spec/models/get_session_result_response_spec.rb +6 -0
- data/spec/models/hpke_test_request_spec.rb +48 -0
- data/spec/models/hpke_test_vp_request_spec.rb +42 -0
- data/spec/models/idemia_mobile_id_provider_output_spec.rb +0 -12
- data/spec/models/japan_my_number_provider_output_spec.rb +54 -0
- data/spec/models/jordan_sanad_input_spec.rb +36 -0
- data/spec/models/mit_id_address_output_spec.rb +66 -0
- data/spec/models/mit_id_provider_output_spec.rb +6 -0
- data/spec/models/provider_input_spec.rb +30 -0
- data/spec/models/provider_output_spec.rb +24 -0
- data/spec/models/provider_spec.rb +6 -0
- data/spec/models/recommend_provider_information_spec.rb +6 -0
- data/spec/models/revolut_provider_output_spec.rb +66 -0
- data/spec/models/sanad_provider_output_spec.rb +66 -0
- data/spec/models/saudi_arabia_nafath_address_spec.rb +132 -0
- data/spec/models/saudi_arabia_nafath_citizen_attributes_spec.rb +186 -0
- data/spec/models/saudi_arabia_nafath_head_of_household_spec.rb +60 -0
- data/spec/models/saudi_arabia_nafath_provider_output_spec.rb +96 -0
- data/spec/models/saudi_arabia_nafath_resident_attributes_spec.rb +186 -0
- data/spec/models/saudi_arabia_nafath_visitor_attributes_spec.rb +198 -0
- data/spec/models/singpass_personal_catalog_spec.rb +1 -1
- data/spec/models/sweden_bank_id_provider_output_spec.rb +12 -0
- data/spec/models/trinsic_hpke_bundle_spec.rb +54 -0
- data/spec/models/trinsic_hpke_metadata_spec.rb +72 -0
- data/spec/models/usa_arizona_wallet_input_spec.rb +36 -0
- data/spec/models/verification_profile_response_spec.rb +6 -0
- metadata +375 -291
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 95bc4abae18e0c49a1147935686e6bb692296e44efd13e1052e8b5b32b1d9a72
|
|
4
|
+
data.tar.gz: aee478eef60c873b9da617984df70894813a94df32fbaae0bd400dbb5c673ec9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6b33172c928a3ce0cf14717c6fd1a2ed03f9aeea0fd493ba2614d075470b31dcb77a4d21409d99623b8c01813b981e0c1ac3f4f21f5cd0da1a9485b11d3ace33
|
|
7
|
+
data.tar.gz: ca4afb7fdca44b7cf3bce1c7ba038387cdab228faf9af43930776df6b9129ca89849bc9cb327021d755ad40a8a1cf9f0c46805813674112b767b421e37cc63bd
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cpf_number** | **String** | 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, | [optional] |
|
|
7
8
|
| **full_name** | [**BrazilCnhMatchFieldString**](BrazilCnhMatchFieldString.md) | Full name decoded from the CNH QR Code and whether it matched the government database. | [optional] |
|
|
8
9
|
| **full_name_similarity** | **Float** | Similarity score for the decoded full name from the CNH QR Code. Ranges from 0.0 to 1.0, where 1.0 is an exact match. | [optional] |
|
|
9
10
|
| **origin_document** | **String** | Source identity document number/reference for the CNH record, decoded from the CNH QR Code. | [optional] |
|
|
@@ -27,6 +28,7 @@
|
|
|
27
28
|
require 'trinsic_api'
|
|
28
29
|
|
|
29
30
|
instance = TrinsicApi::BrazilCnhProviderOutput.new(
|
|
31
|
+
cpf_number: 40442820135,
|
|
30
32
|
full_name: null,
|
|
31
33
|
full_name_similarity: 0.98,
|
|
32
34
|
origin_document: SSP SP 123456789,
|
data/docs/BrazilCpfCheckInput.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **cpf_number** | **String** | The user's 11-digit, numeric CPF Number |
|
|
8
|
-
| **date_of_birth** | **Date** | The user's date of birth
|
|
9
|
-
| **selfie_image** | **String** | The
|
|
7
|
+
| **cpf_number** | **String** | The user's 11-digit, numeric CPF Number | [optional] |
|
|
8
|
+
| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format. Optional in this request; required to complete CPF lookups. | [optional] |
|
|
9
|
+
| **selfie_image** | **String** | 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. | [optional] |
|
|
10
10
|
| **selfie_image_content_type** | **String** | The MIME Type of the file contained in `SelfieImage`. Must be one of `image/jpeg` or `image/png`. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **name** | **String** | The full legal name of the individual. | [optional] |
|
|
13
13
|
| **social_name** | **String** | The social name of the individual in case the individual would like to use a different name than their full legal name. | [optional] |
|
|
14
14
|
| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
|
|
15
|
-
| **year_of_death** | **String** | Deprecated as of September
|
|
15
|
+
| **year_of_death** | **String** | Deprecated as of September 19, 2026. The year of death of the individual, if applicable. | [optional] |
|
|
16
16
|
| **date_of_registration** | **Date** | The date of registration of the individual with the Federal Revenue Service. | [optional] |
|
|
17
17
|
| **biometric_verification** | [**BrazilBiometricVerificationOutput**](BrazilBiometricVerificationOutput.md) | The biometric verification results. This is an optional configurable check. | [optional] |
|
|
18
18
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **cpf_number** | **String** | The user's 11-digit, numeric CPF Number | |
|
|
8
8
|
| **digital_cnh_file** | **String** | The raw bytes of the digital CNH file collected from the user. | [optional] |
|
|
9
9
|
| **digital_cnh_file_content_type** | **String** | The MIME Type of the file contained in `DigitalCnhFile`. Must be one of `application/pdf`, `image/jpeg`, or `image/png`. | [optional] |
|
|
10
|
-
| **facial_biometry_photo** | **String** | The raw bytes of the image of the user's face, collected for biometric comparison. | [optional] |
|
|
10
|
+
| **facial_biometry_photo** | **String** | 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. | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -4,7 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **over16** | **Boolean** | Whether the individual is at least 16 years old. | [optional] |
|
|
8
|
+
| **over18** | **Boolean** | Whether the individual is at least 18 years old. | [optional] |
|
|
9
|
+
| **over21** | **Boolean** | Whether the individual is at least 21 years old. | [optional] |
|
|
10
|
+
| **over25** | **Boolean** | Whether the individual is at least 25 years old. | [optional] |
|
|
11
|
+
| **over65** | **Boolean** | Whether the individual is at least 65 years old. | [optional] |
|
|
8
12
|
| **trust_framework** | **String** | The authority that verified the claim. | [optional] |
|
|
9
13
|
|
|
10
14
|
## Example
|
|
@@ -13,7 +17,11 @@
|
|
|
13
17
|
require 'trinsic_api'
|
|
14
18
|
|
|
15
19
|
instance = TrinsicApi::ConnectIdAgeVerification.new(
|
|
20
|
+
over16: true,
|
|
16
21
|
over18: true,
|
|
22
|
+
over21: true,
|
|
23
|
+
over25: true,
|
|
24
|
+
over65: true,
|
|
17
25
|
trust_framework: au_connectid
|
|
18
26
|
)
|
|
19
27
|
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::ConnectIdInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **sub_provider_id** | **String** | The ID of the specific sub-provider to invoke with ConnectID. If not specified, the user will be prompted to select the sub-provider when `fallbackToHostedUI` is enabled. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::ConnectIdInput.new(
|
|
15
|
+
sub_provider_id: mock-bank-a
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **provider** | **String** | The ID of the provider to launch | |
|
|
8
8
|
| **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. | |
|
|
9
9
|
| **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. This field is required for providers which employ a redirect-based flow. | [optional] |
|
|
10
|
+
| **enable_redirect_backwards_compatibility** | **Boolean** | Defaults to `true` if not provided. Controls backwards compatibility behavior. If `true`, `redirectToken` validation is not required as part of the Session flow. If `false`, `redirectToken` validation is required as a core part of the Session flow; results cannot be fetched without it. (This applies only to `CaptureRedirect` Sessions in Direct mode). This parameter exists to enable backwards compatibility with existing integrations. In the future, this parameter will be removed and `redirectToken` validation will always be required. If your integration supports `redirectToken`, you should explicitly set this parameter's value to `false`. Only set this value to `true` if your integration does not support `redirectToken` and you are not yet able to add support. | |
|
|
10
11
|
| **capabilities** | [**Array<IntegrationCapability>**](IntegrationCapability.md) | The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering. Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method. For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities. If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation. Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/direct-provider-sessions\">the guide on Direct Provider Sessions</a> | |
|
|
11
12
|
| **fallback_to_hosted_ui** | **Boolean** | Whether the session should fall back to a Trinsic-hosted UI in certain instances. Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete - In this case, Trinsic's hosted UI will collect the necessary input from the user If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect. If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field | [optional] |
|
|
12
13
|
| **browser_languages** | **Array<String>** | Preferences for languages to show first in supported provider launch flows and, if the session falls back, in the Trinsic-hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. | [optional] |
|
|
@@ -21,6 +22,7 @@ instance = TrinsicApi::CreateDirectProviderSessionRequest.new(
|
|
|
21
22
|
provider: null,
|
|
22
23
|
verification_profile_id: null,
|
|
23
24
|
redirect_url: null,
|
|
25
|
+
enable_redirect_backwards_compatibility: null,
|
|
24
26
|
capabilities: null,
|
|
25
27
|
fallback_to_hosted_ui: null,
|
|
26
28
|
browser_languages: null,
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **provider** | **String** | The ID of the provider to launch | |
|
|
8
8
|
| **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. | |
|
|
9
9
|
| **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. | |
|
|
10
|
+
| **enable_redirect_backwards_compatibility** | **Boolean** | Defaults to `true` if not provided. Controls backwards compatibility behavior. If `true`, `redirectToken` validation is not required as part of the Session flow. If `false`, `redirectToken` validation is required as a core part of the Session flow; results cannot be fetched without it. This parameter exists to enable backwards compatibility with existing integrations. In the future, this parameter will be removed and `redirectToken` validation will always be required. If your integration supports `redirectToken`, you should explicitly set this parameter's value to `false`. Only set this value to `true` if your integration does not support `redirectToken` and you are not yet able to add support. | |
|
|
10
11
|
| **browser_languages** | **Array<String>** | Preferences for languages to show first in the Hosted UI and supported provider launch flows. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. | [optional] |
|
|
11
12
|
| **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation, and will instead always redirect the user to a hosted interface to collect input. If you need to collect input from the user yourself, please use the Create Direct Session endpoint instead. | [optional] |
|
|
12
13
|
|
|
@@ -19,6 +20,7 @@ instance = TrinsicApi::CreateHostedProviderSessionRequest.new(
|
|
|
19
20
|
provider: null,
|
|
20
21
|
verification_profile_id: null,
|
|
21
22
|
redirect_url: null,
|
|
23
|
+
enable_redirect_backwards_compatibility: null,
|
|
22
24
|
browser_languages: null,
|
|
23
25
|
provider_input: null
|
|
24
26
|
)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::CzechBankIdInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **sub_provider_id** | **String** | The ID of the Czech Bank to invoke. If omitted, the user selects a sub-provider. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::CzechBankIdInput.new(
|
|
15
|
+
sub_provider_id: air-bank
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# TrinsicApi::DeveloperApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.trinsic.id*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**test_against_arbitrary_key**](DeveloperApi.md#test_against_arbitrary_key) | **POST** /api/v1/developer/hpke-test | Test HPKE Against Arbitrary Key |
|
|
8
|
+
| [**test_against_verification_profile**](DeveloperApi.md#test_against_verification_profile) | **POST** /api/v1/developer/hpke-test/{verificationProfileId} | Test HPKE Against Verification Profile Key |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## test_against_arbitrary_key
|
|
12
|
+
|
|
13
|
+
> <TrinsicHPKEBundle> test_against_arbitrary_key(opts)
|
|
14
|
+
|
|
15
|
+
Test HPKE Against Arbitrary Key
|
|
16
|
+
|
|
17
|
+
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.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'trinsic_api'
|
|
24
|
+
# setup authorization
|
|
25
|
+
TrinsicApi.configure do |config|
|
|
26
|
+
# Configure Bearer authorization: Bearer
|
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = TrinsicApi::DeveloperApi.new
|
|
31
|
+
opts = {
|
|
32
|
+
hpke_test_request: TrinsicApi::HPKETestRequest.new({data: 'data_example', info_suffix: 'info_suffix_example', public_key: 'public_key_example'}) # HPKETestRequest |
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Test HPKE Against Arbitrary Key
|
|
37
|
+
result = api_instance.test_against_arbitrary_key(opts)
|
|
38
|
+
p result
|
|
39
|
+
rescue TrinsicApi::ApiError => e
|
|
40
|
+
puts "Error when calling DeveloperApi->test_against_arbitrary_key: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the test_against_arbitrary_key_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(<TrinsicHPKEBundle>, Integer, Hash)> test_against_arbitrary_key_with_http_info(opts)
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Test HPKE Against Arbitrary Key
|
|
53
|
+
data, status_code, headers = api_instance.test_against_arbitrary_key_with_http_info(opts)
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => <TrinsicHPKEBundle>
|
|
57
|
+
rescue TrinsicApi::ApiError => e
|
|
58
|
+
puts "Error when calling DeveloperApi->test_against_arbitrary_key_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
| Name | Type | Description | Notes |
|
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
|
66
|
+
| **hpke_test_request** | [**HPKETestRequest**](HPKETestRequest.md) | | [optional] |
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**TrinsicHPKEBundle**](TrinsicHPKEBundle.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
[Bearer](../README.md#Bearer)
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
79
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## test_against_verification_profile
|
|
83
|
+
|
|
84
|
+
> <TrinsicHPKEBundle> test_against_verification_profile(verification_profile_id, opts)
|
|
85
|
+
|
|
86
|
+
Test HPKE Against Verification Profile Key
|
|
87
|
+
|
|
88
|
+
Encrypts the provided data against the PII encryption key configured on the given verification profile. This is intended for integration testing and development purposes.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'trinsic_api'
|
|
95
|
+
# setup authorization
|
|
96
|
+
TrinsicApi.configure do |config|
|
|
97
|
+
# Configure Bearer authorization: Bearer
|
|
98
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = TrinsicApi::DeveloperApi.new
|
|
102
|
+
verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
103
|
+
opts = {
|
|
104
|
+
hpke_test_vp_request: TrinsicApi::HPKETestVPRequest.new({data: 'data_example', info_suffix: 'info_suffix_example'}) # HPKETestVPRequest |
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
begin
|
|
108
|
+
# Test HPKE Against Verification Profile Key
|
|
109
|
+
result = api_instance.test_against_verification_profile(verification_profile_id, opts)
|
|
110
|
+
p result
|
|
111
|
+
rescue TrinsicApi::ApiError => e
|
|
112
|
+
puts "Error when calling DeveloperApi->test_against_verification_profile: #{e}"
|
|
113
|
+
end
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
#### Using the test_against_verification_profile_with_http_info variant
|
|
117
|
+
|
|
118
|
+
This returns an Array which contains the response data, status code and headers.
|
|
119
|
+
|
|
120
|
+
> <Array(<TrinsicHPKEBundle>, Integer, Hash)> test_against_verification_profile_with_http_info(verification_profile_id, opts)
|
|
121
|
+
|
|
122
|
+
```ruby
|
|
123
|
+
begin
|
|
124
|
+
# Test HPKE Against Verification Profile Key
|
|
125
|
+
data, status_code, headers = api_instance.test_against_verification_profile_with_http_info(verification_profile_id, opts)
|
|
126
|
+
p status_code # => 2xx
|
|
127
|
+
p headers # => { ... }
|
|
128
|
+
p data # => <TrinsicHPKEBundle>
|
|
129
|
+
rescue TrinsicApi::ApiError => e
|
|
130
|
+
puts "Error when calling DeveloperApi->test_against_verification_profile_with_http_info: #{e}"
|
|
131
|
+
end
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Parameters
|
|
135
|
+
|
|
136
|
+
| Name | Type | Description | Notes |
|
|
137
|
+
| ---- | ---- | ----------- | ----- |
|
|
138
|
+
| **verification_profile_id** | **String** | | |
|
|
139
|
+
| **hpke_test_vp_request** | [**HPKETestVPRequest**](HPKETestVPRequest.md) | | [optional] |
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
[**TrinsicHPKEBundle**](TrinsicHPKEBundle.md)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[Bearer](../README.md#Bearer)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
152
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
153
|
+
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **aadhaar_number_last_four** | **String** | The Aadhaar number (UID) value for the individual. This is only the last four digits of the Aadhaar number. | [optional] |
|
|
11
11
|
| **claims** | [**AadhaarClaims**](AadhaarClaims.md) | The claims extracted from the Aadhaar document. | [optional] |
|
|
12
12
|
| **localized_claims** | [**AadhaarLocalizedClaims**](AadhaarLocalizedClaims.md) | The localized claims extracted from the Aadhaar document. | [optional] |
|
|
13
|
-
| **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded. When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers
|
|
13
|
+
| **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded. When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation. | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::FinnishTrustNetworkAddressOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **locality** | **String** | The locality of the address. | [optional] |
|
|
8
|
+
| **postal_code** | **String** | The postal code of the address. | [optional] |
|
|
9
|
+
| **street_address** | **String** | The street address of the individual. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::FinnishTrustNetworkAddressOutput.new(
|
|
17
|
+
locality: Helsinki,
|
|
18
|
+
postal_code: 00100,
|
|
19
|
+
street_address: Mannerheimintie 30
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::FinnishTrustNetworkInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **sub_provider_id** | **String** | The ID of the FTN bank or mobile ID to invoke. If omitted, the user selects a sub-provider. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::FinnishTrustNetworkInput.new(
|
|
15
|
+
sub_provider_id: opbank
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification. The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance Possible values: - Low: The individual has self asserted their identity and multifactor authentication is not required. - Substantial: The individual has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The individual has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [optional] |
|
|
14
14
|
| **bank** | **String** | The bank used to perform the identification for the verified individual. | [optional] |
|
|
15
15
|
| **phone_number** | **String** | The phone number of the verified individual. This is only returned if the individual authenticated with MobileID (Mobiilivarmenne). | [optional] |
|
|
16
|
+
| **address** | [**FinnishTrustNetworkAddressOutput**](FinnishTrustNetworkAddressOutput.md) | The address of the individual. | [optional] |
|
|
16
17
|
| **organization_name** | **String** | The organization name that the individual is associated with. This is returned for requests that contain the organization scope. | [optional] |
|
|
17
18
|
| **vat_number** | **String** | The VAT number of the organization that the individual is associated with. This is returned for requests that contain the organization scope. | [optional] |
|
|
18
19
|
|
|
@@ -31,6 +32,7 @@ instance = TrinsicApi::FinnishTrustNetworkProviderOutput.new(
|
|
|
31
32
|
level_of_assurance: High,
|
|
32
33
|
bank: opbank,
|
|
33
34
|
phone_number: +358401234567,
|
|
35
|
+
address: null,
|
|
34
36
|
organization_name: Acme Company,
|
|
35
37
|
vat_number: FI07654321
|
|
36
38
|
)
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **content** | **String** | The file contents of the Attachment. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64. Combine this with the Content type to reconstruct the file. This is empty when `encryptedContent` is present. | |
|
|
8
|
+
| **encrypted_content** | [**TrinsicHPKEBundle**](TrinsicHPKEBundle.md) | The HPKE Bundle containing the encrypted contents of the Attachment, if secured via HPKE. Decrypt it using the HPKE info string `trinsic-hpke:1:attachment-contents:{sessionId}:{attachmentId}`. | [optional] |
|
|
8
9
|
| **content_type** | **String** | The MIME type of the Attachment data | |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
@@ -14,6 +15,7 @@ require 'trinsic_api'
|
|
|
14
15
|
|
|
15
16
|
instance = TrinsicApi::GetAttachmentResponse.new(
|
|
16
17
|
content: null,
|
|
18
|
+
encrypted_content: null,
|
|
17
19
|
content_type: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **results_access_key** | **String** | The Results Access Key to exchange | |
|
|
8
|
+
| **redirect_token** | **String** | The `redirectToken` which Trinsic appended to your Redirect URL before sending the user back to your application. This is only relevant for Sessions which involve a redirect flow. If a `redirectToken` is required for a Session, it is only required for the first call to `GetSessionResult`. Future calls do not require a `redirectToken`. | [optional] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'trinsic_api'
|
|
13
14
|
|
|
14
15
|
instance = TrinsicApi::GetSessionResultRequest.new(
|
|
15
|
-
results_access_key: null
|
|
16
|
+
results_access_key: null,
|
|
17
|
+
redirect_token: null
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **session** | [**Session**](Session.md) | The Session in its current state. | |
|
|
8
8
|
| **identity_data** | [**IdentityData**](IdentityData.md) | The IdentityData which resulted from the Session, if not HPKE-encrypted. | [optional] |
|
|
9
|
+
| **encrypted_identity_data** | [**TrinsicHPKEBundle**](TrinsicHPKEBundle.md) | The HPKE-encrypted IdentityData which resulted from the Session, if HPKE-encrypted. | [optional] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'trinsic_api'
|
|
|
14
15
|
|
|
15
16
|
instance = TrinsicApi::GetSessionResultResponse.new(
|
|
16
17
|
session: null,
|
|
17
|
-
identity_data: null
|
|
18
|
+
identity_data: null,
|
|
19
|
+
encrypted_identity_data: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::HPKETestRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | **String** | The data to encrypt. Must be between 0 and 1024 bytes. | |
|
|
8
|
+
| **info_suffix** | **String** | A 32-character suffix appended to the fixed info prefix to form the HPKE info parameter. | |
|
|
9
|
+
| **public_key** | **String** | The recipient's public key, as a JWK or PEM string. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::HPKETestRequest.new(
|
|
17
|
+
data: null,
|
|
18
|
+
info_suffix: null,
|
|
19
|
+
public_key: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::HPKETestVPRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | **String** | The data to encrypt. Must be between 0 and 1024 bytes. | |
|
|
8
|
+
| **info_suffix** | **String** | A 32-byte suffix appended to the fixed info prefix to form the HPKE info parameter. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::HPKETestVPRequest.new(
|
|
16
|
+
data: null,
|
|
17
|
+
info_suffix: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -18,8 +18,6 @@
|
|
|
18
18
|
| **resident_country** | **String** | The individual's resident country. | [optional] |
|
|
19
19
|
| **resident_postal_code** | **String** | The individual's resident postal code. | [optional] |
|
|
20
20
|
| **resident_city** | **String** | The individual's resident city. | [optional] |
|
|
21
|
-
| **email** | **String** | The individual's email address. | [optional] |
|
|
22
|
-
| **email_verified** | **Boolean** | Whether the individual's email address has been verified. | [optional] |
|
|
23
21
|
| **document_number** | **String** | The individual's document number. | [optional] |
|
|
24
22
|
| **issue_date** | **String** | The date the document was issued. | [optional] |
|
|
25
23
|
| **issuing_country** | **String** | The country that issued the document. | [optional] |
|
|
@@ -49,15 +47,13 @@ instance = TrinsicApi::IdemiaMobileIdProviderOutput.new(
|
|
|
49
47
|
resident_country: USA,
|
|
50
48
|
resident_postal_code: 12207,
|
|
51
49
|
resident_city: Albany,
|
|
52
|
-
email: jane.doe@example.com,
|
|
53
|
-
email_verified: true,
|
|
54
50
|
document_number: D1234567,
|
|
55
51
|
issue_date: 2021-01-31,
|
|
56
52
|
issuing_country: USA,
|
|
57
53
|
issuing_authority: New York DMV,
|
|
58
54
|
expiry_date: 2031-01-31,
|
|
59
55
|
issuing_jurisdiction: NY,
|
|
60
|
-
document_type:
|
|
56
|
+
document_type: DL,
|
|
61
57
|
sex: female
|
|
62
58
|
)
|
|
63
59
|
```
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **middle_name** | **String** | Middle name of the individual. NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
|
|
12
12
|
| **family_name** | **String** | Family name of the individual. NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
|
|
13
13
|
| **date_of_birth** | **String** | Date of birth of the individual. NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
|
|
14
|
-
| **pan_status** | **String** | PAN card status
|
|
14
|
+
| **pan_status** | **String** | PAN card status returned by the lookup provider. Possible values: - VALID - FAKE - DEACTIVATED - DELETED - INVALID - AMALGAMATION - ACQUISITION - DEATH - DISSOLUTION - LIQUIDATED - MERGER - PARTITION - SPLIT - UNDER LIQUIDATION - INOPERATIVE | [optional] |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **nik_id_number** | **String** | The user's Indonesia NIK ID number | [optional] |
|
|
10
10
|
| **email** | **String** | The email address of the individual. Either email or phone number must be provided. | [optional] |
|
|
11
11
|
| **phone_number** | **String** | The phone number of the individual. Either email or phone number must be provided. | [optional] |
|
|
12
|
-
| **selfie_image** | **String** | The raw bytes of the selfie image of the individual. Must be JPEG or PNG format; 10MB maximum. | [optional] |
|
|
12
|
+
| **selfie_image** | **String** | The raw bytes of the selfie image of the individual. Must be JPEG or PNG format; 10MB maximum. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64. | [optional] |
|
|
13
13
|
| **document_image** | **String** | The raw bytes of the image of the individual's KTP government ID. Must be JPEG format; 1MB maximum. Optional. | [optional] |
|
|
14
14
|
| **consent_given_at** | **Time** | The timestamp when consent was given by the user for the verification. | [optional] |
|
|
15
15
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TrinsicApi::JapanMyNumberProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The individual's full name as recorded on the card, preserving its original script and spacing. | [optional] |
|
|
8
|
+
| **address** | **String** | The individual's full address as recorded on the card, preserving its original script and spacing. | [optional] |
|
|
9
|
+
| **date_of_birth** | **Date** | The individual's Gregorian date of birth in YYYY-MM-DD format. | [optional] |
|
|
10
|
+
| **sex** | **String** | The original sex code returned for the verified individual. Known values: - 1: Male. - 2: Female. - 9: Other; omitted from normalized sex because it has no equivalent value. An absent code means it was not supplied. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'trinsic_api'
|
|
16
|
+
|
|
17
|
+
instance = TrinsicApi::JapanMyNumberProviderOutput.new(
|
|
18
|
+
name: 試験 花子,
|
|
19
|
+
address: 東京都架空市試験町1ー2ー3 テスト棟4階,
|
|
20
|
+
date_of_birth: Tue Feb 29 00:00:00 UTC 2000,
|
|
21
|
+
sex: 2
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::JordanSanadInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **qr_code_text** | **String** | The decoded contents of the user's SANAD QR code. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::JordanSanadInput.new(
|
|
15
|
+
qr_code_text: synthetic-sanad-qr
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# TrinsicApi::MitIdAddressOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **city_name** | **String** | The city name returned by MitID. | [optional] |
|
|
8
|
+
| **zip_name** | **String** | The postal district name returned by MitID. | [optional] |
|
|
9
|
+
| **street_number** | **String** | The street number. | [optional] |
|
|
10
|
+
| **street_name** | **String** | The street name. | [optional] |
|
|
11
|
+
| **zip_code** | **String** | The zip code. | [optional] |
|
|
12
|
+
| **country_code** | **String** | The ISO 3166-1 alpha-2 country code, set to DK (Denmark). | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'trinsic_api'
|
|
18
|
+
|
|
19
|
+
instance = TrinsicApi::MitIdAddressOutput.new(
|
|
20
|
+
city_name: København,
|
|
21
|
+
zip_name: København K,
|
|
22
|
+
street_number: 12A,
|
|
23
|
+
street_name: Nørregade,
|
|
24
|
+
zip_code: 1165,
|
|
25
|
+
country_code: DK
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/MitIdProviderOutput.md
CHANGED
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
| **organization_name** | **String** | The name of the organization for the verification | [optional] |
|
|
16
16
|
| **organization_number** | **String** | The organization number (CVR number). This is an 8-digit unique identifier for the organization. This will be prefixed with \"DK\" for VAT numbers. | [optional] |
|
|
17
17
|
| **authorized_representative_number** | **String** | The organization number (CVR number) of the organization the individual is authorized to represent. This is only returned if the requested scope is for an organization verification and the individual provides a private source on behalf of a company. | [optional] |
|
|
18
|
+
| **address** | [**MitIdAddressOutput**](MitIdAddressOutput.md) | The individual's address. | [optional] |
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,7 +33,8 @@ instance = TrinsicApi::MitIdProviderOutput.new(
|
|
|
32
33
|
civil_registration_number: 01311985-1234,
|
|
33
34
|
organization_name: Dansk Standard,
|
|
34
35
|
organization_number: DK12345678,
|
|
35
|
-
authorized_representative_number: 8ba191ec-64b1-41c1-b622-4b8c14c34428
|
|
36
|
+
authorized_representative_number: 8ba191ec-64b1-41c1-b622-4b8c14c34428,
|
|
37
|
+
address: null
|
|
36
38
|
)
|
|
37
39
|
```
|
|
38
40
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **nationality** | **String** | Nationality as it appears on mobile ID (mDowód). Format: - Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code. - Matching against mObywatel is an exact string comparison on the alpha-3 code. Alpha-2 values are accepted and normalized to alpha-3 before matching. | [optional] |
|
|
11
11
|
| **personal_number** | **String** | Polish national identification number (PESEL) as it appears on mobile ID (mDowód). NOTE: The provided example value is a randomly generated, but valid PESEL number that does not correspond to a real person. | [optional] |
|
|
12
12
|
| **expiration_date** | **String** | Document expiration date as it appears on mobile ID (mDowód). | [optional] |
|
|
13
|
-
| **selfie_bytes** | **String** | The raw bytes of an optional selfie image collected from the individual. Requirements from the provider: - JPEG or PNG - At least 720 pixels wide (1080 pixels recommended) - Not exceeding 10 MB - Clear, front-facing photo with good lighting and no sunglasses or face coverings. | [optional] |
|
|
13
|
+
| **selfie_bytes** | **String** | The raw bytes of an optional selfie image collected from the individual. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64. Requirements from the provider: - JPEG or PNG - At least 720 pixels wide (1080 pixels recommended) - Not exceeding 10 MB - Clear, front-facing photo with good lighting and no sunglasses or face coverings. | [optional] |
|
|
14
14
|
| **selfie_image_mime_type** | **String** | The MIME type of the file contained in SelfieBytes. Must be one of `image/jpeg` or `image/png`. | [optional] |
|
|
15
15
|
|
|
16
16
|
## Example
|