trinsic_api 2.3.0.pre.alpha2 → 3.0.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.
- checksums.yaml +4 -4
- data/docs/{EnvironmentRedirectUrisAddRequest.md → AddRedirectUriRequest.md} +2 -2
- data/docs/Address.md +2 -2
- data/docs/AppleWalletProviderOutput.md +18 -0
- data/docs/AttachmentInfo.md +24 -0
- data/docs/{MdlFieldDataType.md → AttributeAvailability.md} +2 -2
- data/docs/AustriaHandySignaturProviderOutput.md +20 -0
- data/docs/BelgiumIdCardProviderOutput.md +24 -0
- data/docs/ContractAttachment.md +20 -0
- data/docs/ContractAttribute.md +20 -0
- data/docs/CoteDIvoireNidLookup2Input.md +18 -0
- data/docs/CzechiaMojeIdProviderOutput.md +24 -0
- data/docs/DocumentData.md +12 -10
- data/docs/EstoniaIdCardProviderOutput.md +24 -0
- data/docs/FaydaProviderOutput.md +1 -1
- data/docs/FinlandIdCardProviderOutput.md +24 -0
- data/docs/FrejaProviderOutput.md +24 -0
- data/docs/FrenchNumeriqueGivenName.md +22 -0
- data/docs/FrenchNumeriqueNationality.md +20 -0
- data/docs/FrenchNumeriquePhone.md +22 -0
- data/docs/FrenchNumeriqueProviderOutput.md +66 -0
- data/docs/GetAttachmentRequest.md +2 -4
- data/docs/GoogleWalletProviderOutput.md +18 -0
- data/docs/IdentityData.md +9 -11
- data/docs/ItsmeProviderOutput.md +26 -0
- data/docs/KenyaNidMatch2Input.md +1 -1
- data/docs/{Language.md → KenyaNidMatch2InputSex.md} +2 -2
- data/docs/LaWalletProviderOutput.md +52 -0
- data/docs/LatviaEparakstsMobileProviderOutput.md +22 -0
- data/docs/LatviaEparakstsProviderOutput.md +22 -0
- data/docs/ListProvidersResponse.md +1 -1
- data/docs/{ListEnvironmentRedirectUrisResponse.md → ListRedirectUrisResponse.md} +2 -2
- data/docs/LithuaniaIdCardProviderOutput.md +24 -0
- data/docs/LloydsSmartIdProviderOutput.md +40 -0
- data/docs/Match.md +2 -2
- data/docs/MatchData.md +12 -10
- data/docs/MdlOutput.md +24 -0
- data/docs/MdlOutputCertificateData.md +26 -0
- data/docs/{ExternalMdlFieldData.md → MdlOutputFieldData.md} +3 -3
- data/docs/{FieldAvailability.md → MdlOutputFieldDataType.md} +2 -2
- data/docs/MexicoCurpProviderOutput.md +1 -1
- data/docs/MitIdProviderOutput.md +38 -0
- data/docs/MobileIdInput.md +1 -1
- data/docs/{SexV1.md → MobileIdLanguage.md} +2 -2
- data/docs/MobileIdProviderOutput.md +34 -0
- data/docs/NigeriaNinBiometric2Input.md +22 -0
- data/docs/NigeriaNinLookup2Input.md +18 -0
- data/docs/NigeriaNinMatch2Input.md +30 -0
- data/docs/NigeriaNinMatch2InputSex.md +15 -0
- data/docs/PersonData.md +10 -10
- data/docs/PeruDniAddress.md +22 -0
- data/docs/PeruDniLookupInput.md +18 -0
- data/docs/PeruDniProviderOutput.md +48 -0
- data/docs/PhilippinesDigitalNidProviderOutput.md +2 -2
- data/docs/PhilippinesPhysicalNidProviderOutput.md +2 -2
- data/docs/PolandEdoAppProviderOutput.md +24 -0
- data/docs/PolandMojeIdProviderOutput.md +22 -0
- data/docs/PortugalIdCardProviderOutput.md +24 -0
- data/docs/PostOfficeEasyIdProviderOutput.md +40 -0
- data/docs/{ProviderContract.md → Provider.md} +29 -25
- data/docs/ProviderInput.md +50 -32
- data/docs/ProviderOutput.md +61 -7
- data/docs/ProvidersApi.md +79 -0
- data/docs/RecommendProviderHealthOption.md +15 -0
- data/docs/{ProviderInformation.md → RecommendProviderInformation.md} +14 -14
- data/docs/{RecommendRequest.md → RecommendProvidersRequest.md} +3 -3
- data/docs/RecommendProvidersResponse.md +18 -0
- data/docs/{EnvironmentRedirectUrisApi.md → RedirectUrisApi.md} +21 -21
- data/docs/SamsungWalletProviderOutput.md +18 -0
- data/docs/SerbiaIdCardProviderOutput.md +24 -0
- data/docs/SessionsApi.md +149 -1
- data/docs/SmartIdInput.md +0 -2
- data/docs/SmartIdProviderOutput.md +42 -0
- data/docs/SouthAfricaNidBiometric2Input.md +22 -0
- data/docs/SouthAfricaNidMatch2Input.md +30 -0
- data/docs/SouthAfricaNidMatch2InputSex.md +15 -0
- data/docs/SpidProviderOutput.md +45 -25
- data/docs/SubProviderMetadata.md +0 -2
- data/docs/SwedenBankIdProviderOutput.md +42 -0
- data/docs/UgandaNidMatch2Input.md +22 -0
- data/docs/VerificationProfileResponse.md +3 -1
- data/docs/VerificationProfilesApi.md +3 -1
- data/docs/YotiDocumentDetails.md +26 -0
- data/docs/YotiProviderOutput.md +40 -0
- data/docs/YotiStructuredPostalAddress.md +56 -0
- data/docs/ZimbabweNidLookup2Input.md +18 -0
- data/lib/trinsic_api/api/providers_api.rb +82 -0
- data/lib/trinsic_api/api/{environment_redirect_uris_api.rb → redirect_uris_api.rb} +28 -28
- data/lib/trinsic_api/api/sessions_api.rb +142 -2
- data/lib/trinsic_api/api/verification_profiles_api.rb +3 -0
- data/lib/trinsic_api/models/{environment_redirect_uris_add_request.rb → add_redirect_uri_request.rb} +12 -3
- data/lib/trinsic_api/models/address.rb +3 -0
- data/lib/trinsic_api/models/apple_wallet_provider_output.rb +239 -0
- data/lib/trinsic_api/models/attachment_info.rb +319 -0
- data/lib/trinsic_api/models/{field_availability.rb → attribute_availability.rb} +3 -3
- data/lib/trinsic_api/models/austria_handy_signatur_provider_output.rb +266 -0
- data/lib/trinsic_api/models/{bangladesh_nid_input.rb → belgium_id_card_provider_output.rb} +60 -90
- data/lib/trinsic_api/models/{contract_identifier_field.rb → contract_attachment.rb} +25 -52
- data/lib/trinsic_api/models/{contract_field.rb → contract_attribute.rb} +8 -35
- data/lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_input.rb +222 -0
- data/lib/trinsic_api/models/{finalize_mdl_exchange_response.rb → czechia_moje_id_provider_output.rb} +85 -52
- data/lib/trinsic_api/models/document_data.rb +18 -1
- data/lib/trinsic_api/models/estonia_id_card_provider_output.rb +320 -0
- data/lib/trinsic_api/models/fayda_provider_output.rb +1 -0
- data/lib/trinsic_api/models/finland_id_card_provider_output.rb +320 -0
- data/lib/trinsic_api/models/freja_provider_output.rb +320 -0
- data/lib/trinsic_api/models/french_numerique_given_name.rb +245 -0
- data/lib/trinsic_api/models/french_numerique_nationality.rb +234 -0
- data/lib/trinsic_api/models/french_numerique_phone.rb +245 -0
- data/lib/trinsic_api/models/french_numerique_provider_output.rb +487 -0
- data/lib/trinsic_api/models/get_attachment_request.rb +22 -49
- data/lib/trinsic_api/models/google_wallet_provider_output.rb +239 -0
- data/lib/trinsic_api/models/identity_data.rb +30 -33
- data/lib/trinsic_api/models/itsme_provider_output.rb +315 -0
- data/lib/trinsic_api/models/kenya_nid_match2_input.rb +1 -1
- data/lib/trinsic_api/models/{sex_v1.rb → kenya_nid_match2_input_sex.rb} +4 -6
- data/lib/trinsic_api/models/la_wallet_provider_output.rb +682 -0
- data/lib/trinsic_api/models/latvia_eparaksts_mobile_provider_output.rb +293 -0
- data/lib/trinsic_api/models/{create_mdl_exchange_response.rb → latvia_eparaksts_provider_output.rb} +53 -52
- data/lib/trinsic_api/models/list_providers_response.rb +2 -2
- data/lib/trinsic_api/models/{list_environment_redirect_uris_response.rb → list_redirect_uris_response.rb} +3 -3
- data/lib/trinsic_api/models/lithuania_id_card_provider_output.rb +320 -0
- data/lib/trinsic_api/models/lloyds_smart_id_provider_output.rb +344 -0
- data/lib/trinsic_api/models/match.rb +2 -0
- data/lib/trinsic_api/models/match_data.rb +23 -1
- data/lib/trinsic_api/models/{mdl_identity_data.rb → mdl_output.rb} +35 -8
- data/lib/trinsic_api/models/{mdl_certificate_data.rb → mdl_output_certificate_data.rb} +4 -4
- data/lib/trinsic_api/models/{external_mdl_field_data.rb → mdl_output_field_data.rb} +4 -4
- data/lib/trinsic_api/models/{mdl_field_data_type.rb → mdl_output_field_data_type.rb} +5 -4
- data/lib/trinsic_api/models/mexico_curp_provider_output.rb +1 -0
- data/lib/trinsic_api/models/mit_id_provider_output.rb +333 -0
- data/lib/trinsic_api/models/mobile_id_input.rb +1 -1
- data/lib/trinsic_api/models/{language.rb → mobile_id_language.rb} +3 -3
- data/lib/trinsic_api/models/mobile_id_provider_output.rb +311 -0
- data/lib/trinsic_api/models/nigeria_nin_biometric2_input.rb +246 -0
- data/lib/trinsic_api/models/{provider_attachments.rb → nigeria_nin_lookup2_input.rb} +12 -11
- data/lib/trinsic_api/models/{recommend_response.rb → nigeria_nin_match2_input.rb} +94 -82
- data/lib/trinsic_api/models/nigeria_nin_match2_input_sex.rb +40 -0
- data/lib/trinsic_api/models/person_data.rb +7 -0
- data/lib/trinsic_api/models/{identifier.rb → peru_dni_address.rb} +53 -49
- data/lib/trinsic_api/models/peru_dni_lookup_input.rb +222 -0
- data/lib/trinsic_api/models/peru_dni_provider_output.rb +518 -0
- data/lib/trinsic_api/models/philippines_digital_nid_provider_output.rb +2 -1
- data/lib/trinsic_api/models/philippines_physical_nid_provider_output.rb +2 -1
- data/lib/trinsic_api/models/poland_edo_app_provider_output.rb +320 -0
- data/lib/trinsic_api/models/poland_moje_id_provider_output.rb +293 -0
- data/lib/trinsic_api/models/{finalize_mdl_exchange_request.rb → portugal_id_card_provider_output.rb} +69 -68
- data/lib/trinsic_api/models/post_office_easy_id_provider_output.rb +344 -0
- data/lib/trinsic_api/models/{provider_contract.rb → provider.rb} +183 -125
- data/lib/trinsic_api/models/provider_input.rb +223 -124
- data/lib/trinsic_api/models/provider_output.rb +317 -15
- data/lib/trinsic_api/models/recommend_provider_health_option.rb +41 -0
- data/lib/trinsic_api/models/{provider_information.rb → recommend_provider_information.rb} +79 -73
- data/lib/trinsic_api/models/{recommend_request.rb → recommend_providers_request.rb} +27 -5
- data/lib/trinsic_api/models/{list_provider_contracts_response.rb → recommend_providers_response.rb} +20 -21
- data/lib/trinsic_api/models/redirect_uri_response.rb +9 -0
- data/lib/trinsic_api/models/samsung_wallet_provider_output.rb +239 -0
- data/lib/trinsic_api/models/serbia_id_card_provider_output.rb +320 -0
- data/lib/trinsic_api/models/smart_id_input.rb +1 -12
- data/lib/trinsic_api/models/smart_id_provider_output.rb +355 -0
- data/lib/trinsic_api/models/south_africa_nid_biometric2_input.rb +246 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_input.rb +310 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_input_sex.rb +40 -0
- data/lib/trinsic_api/models/spid_provider_output.rb +131 -20
- data/lib/trinsic_api/models/sub_provider_metadata.rb +1 -28
- data/lib/trinsic_api/models/{provider_info.rb → sweden_bank_id_provider_output.rb} +121 -153
- data/lib/trinsic_api/models/uganda_nid_match2_input.rb +244 -0
- data/lib/trinsic_api/models/verification_profile_response.rb +31 -4
- data/lib/trinsic_api/models/yoti_document_details.rb +266 -0
- data/lib/trinsic_api/models/yoti_provider_output.rb +344 -0
- data/lib/trinsic_api/models/yoti_structured_postal_address.rb +431 -0
- data/lib/trinsic_api/models/{document_scan_attachments.rb → zimbabwe_nid_lookup2_input.rb} +12 -11
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +63 -30
- data/spec/api/providers_api_spec.rb +47 -0
- data/spec/api/{environment_redirect_uris_api_spec.rb → redirect_uris_api_spec.rb} +10 -10
- data/spec/api/sessions_api_spec.rb +27 -1
- data/spec/api/verification_profiles_api_spec.rb +1 -0
- data/spec/models/{environment_redirect_uris_add_request_spec.rb → add_redirect_uri_request_spec.rb} +6 -6
- data/spec/models/{list_provider_contracts_response_spec.rb → apple_wallet_provider_output_spec.rb} +7 -7
- data/spec/models/attachment_info_spec.rb +54 -0
- data/spec/models/{mdl_field_data_type_spec.rb → attribute_availability_spec.rb} +6 -6
- data/spec/models/austria_handy_signatur_provider_output_spec.rb +42 -0
- data/spec/models/{finalize_mdl_exchange_response_spec.rb → belgium_id_card_provider_output_spec.rb} +10 -10
- data/spec/models/contract_attachment_spec.rb +42 -0
- data/spec/models/contract_attribute_spec.rb +42 -0
- data/spec/models/cote_d_ivoire_nid_lookup2_input_spec.rb +36 -0
- data/spec/models/czechia_moje_id_provider_output_spec.rb +54 -0
- data/spec/models/document_data_spec.rb +6 -0
- data/spec/models/estonia_id_card_provider_output_spec.rb +54 -0
- data/spec/models/finland_id_card_provider_output_spec.rb +54 -0
- data/spec/models/freja_provider_output_spec.rb +54 -0
- data/spec/models/french_numerique_given_name_spec.rb +48 -0
- data/spec/models/french_numerique_nationality_spec.rb +42 -0
- data/spec/models/{contract_identifier_field_spec.rb → french_numerique_phone_spec.rb} +9 -9
- data/spec/models/french_numerique_provider_output_spec.rb +180 -0
- data/spec/models/get_attachment_request_spec.rb +1 -7
- data/spec/models/google_wallet_provider_output_spec.rb +36 -0
- data/spec/models/identity_data_spec.rb +1 -7
- data/spec/models/{bangladesh_nid_input_spec.rb → itsme_provider_output_spec.rb} +11 -11
- data/spec/models/{sex_v1_spec.rb → kenya_nid_match2_input_sex_spec.rb} +6 -6
- data/spec/models/la_wallet_provider_output_spec.rb +138 -0
- data/spec/models/latvia_eparaksts_mobile_provider_output_spec.rb +48 -0
- data/spec/models/latvia_eparaksts_provider_output_spec.rb +48 -0
- data/spec/models/{list_environment_redirect_uris_response_spec.rb → list_redirect_uris_response_spec.rb} +6 -6
- data/spec/models/lithuania_id_card_provider_output_spec.rb +54 -0
- data/spec/models/lloyds_smart_id_provider_output_spec.rb +102 -0
- data/spec/models/match_data_spec.rb +6 -0
- data/spec/models/{mdl_certificate_data_spec.rb → mdl_output_certificate_data_spec.rb} +6 -6
- data/spec/models/{external_mdl_field_data_spec.rb → mdl_output_field_data_spec.rb} +6 -6
- data/spec/models/{field_availability_spec.rb → mdl_output_field_data_type_spec.rb} +6 -6
- data/spec/models/{mdl_identity_data_spec.rb → mdl_output_spec.rb} +12 -6
- data/spec/models/mit_id_provider_output_spec.rb +96 -0
- data/spec/models/{language_spec.rb → mobile_id_language_spec.rb} +6 -6
- data/spec/models/{create_mdl_exchange_request_spec.rb → mobile_id_provider_output_spec.rb} +20 -14
- data/spec/models/nigeria_nin_biometric2_input_spec.rb +48 -0
- data/spec/models/{document_scan_attachments_spec.rb → nigeria_nin_lookup2_input_spec.rb} +7 -7
- data/spec/models/nigeria_nin_match2_input_sex_spec.rb +30 -0
- data/spec/models/{provider_info_spec.rb → nigeria_nin_match2_input_spec.rb} +13 -13
- data/spec/models/{identifier_spec.rb → peru_dni_address_spec.rb} +9 -9
- data/spec/models/{provider_attachments_spec.rb → peru_dni_lookup_input_spec.rb} +7 -7
- data/spec/models/peru_dni_provider_output_spec.rb +126 -0
- data/spec/models/{finalize_mdl_exchange_request_spec.rb → poland_edo_app_provider_output_spec.rb} +10 -10
- data/spec/models/{create_mdl_exchange_response_spec.rb → poland_moje_id_provider_output_spec.rb} +9 -9
- data/spec/models/portugal_id_card_provider_output_spec.rb +54 -0
- data/spec/models/post_office_easy_id_provider_output_spec.rb +102 -0
- data/spec/models/provider_input_spec.rb +70 -16
- data/spec/models/provider_output_spec.rb +164 -2
- data/spec/models/{provider_contract_spec.rb → provider_spec.rb} +28 -16
- data/spec/models/recommend_provider_health_option_spec.rb +30 -0
- data/spec/models/{provider_information_spec.rb → recommend_provider_information_spec.rb} +11 -11
- data/spec/models/{recommend_request_spec.rb → recommend_providers_request_spec.rb} +6 -6
- data/spec/models/recommend_providers_response_spec.rb +36 -0
- data/spec/models/samsung_wallet_provider_output_spec.rb +36 -0
- data/spec/models/serbia_id_card_provider_output_spec.rb +54 -0
- data/spec/models/smart_id_input_spec.rb +0 -6
- data/spec/models/smart_id_provider_output_spec.rb +108 -0
- data/spec/models/south_africa_nid_biometric2_input_spec.rb +48 -0
- data/spec/models/south_africa_nid_match2_input_sex_spec.rb +30 -0
- data/spec/models/{attachment_access_keys_spec.rb → south_africa_nid_match2_input_spec.rb} +18 -12
- data/spec/models/spid_provider_output_spec.rb +61 -1
- data/spec/models/sub_provider_metadata_spec.rb +0 -6
- data/spec/models/sweden_bank_id_provider_output_spec.rb +108 -0
- data/spec/models/{contract_field_spec.rb → uganda_nid_match2_input_spec.rb} +9 -9
- data/spec/models/verification_profile_response_spec.rb +6 -0
- data/spec/models/yoti_document_details_spec.rb +60 -0
- data/spec/models/yoti_provider_output_spec.rb +102 -0
- data/spec/models/yoti_structured_postal_address_spec.rb +150 -0
- data/spec/models/zimbabwe_nid_lookup2_input_spec.rb +36 -0
- metadata +254 -122
- data/docs/AttachmentAccessKeys.md +0 -28
- data/docs/AttachmentsApi.md +0 -79
- data/docs/BangladeshNidInput.md +0 -26
- data/docs/ContractField.md +0 -22
- data/docs/ContractIdentifierField.md +0 -22
- data/docs/CreateMdlExchangeRequest.md +0 -32
- data/docs/CreateMdlExchangeResponse.md +0 -22
- data/docs/DocumentScanAttachments.md +0 -18
- data/docs/FinalizeMdlExchangeRequest.md +0 -24
- data/docs/FinalizeMdlExchangeResponse.md +0 -24
- data/docs/Identifier.md +0 -22
- data/docs/ListProviderContractsResponse.md +0 -18
- data/docs/MdlApi.md +0 -151
- data/docs/MdlCertificateData.md +0 -26
- data/docs/MdlIdentityData.md +0 -22
- data/docs/NetworkApi.md +0 -223
- data/docs/ProviderAttachments.md +0 -18
- data/docs/ProviderInfo.md +0 -30
- data/docs/RecommendResponse.md +0 -22
- data/lib/trinsic_api/api/attachments_api.rb +0 -86
- data/lib/trinsic_api/api/mdl_api.rb +0 -150
- data/lib/trinsic_api/api/network_api.rb +0 -215
- data/lib/trinsic_api/models/attachment_access_keys.rb +0 -287
- data/lib/trinsic_api/models/create_mdl_exchange_request.rb +0 -404
- data/spec/api/attachments_api_spec.rb +0 -47
- data/spec/api/mdl_api_spec.rb +0 -59
- data/spec/api/network_api_spec.rb +0 -72
- data/spec/models/recommend_response_spec.rb +0 -48
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
# TrinsicApi::
|
|
1
|
+
# TrinsicApi::RecommendProviderInformation
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | The ID of the provider |
|
|
8
|
-
| **name** | **String** | The friendly, human-readable name of the provider |
|
|
9
|
-
| **logo_url** | **String** | A URL pointing to the provider's logo |
|
|
10
|
-
| **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. |
|
|
11
|
-
| **
|
|
12
|
-
| **provider_display_name** | **String** | The friendly, human-readable name of the provider | |
|
|
13
|
-
| **provider_logo** | **String** | A URL pointing to the provider's logo | |
|
|
14
|
-
| **health** | **String** | The current health status of the provider | |
|
|
7
|
+
| **id** | **String** | The ID of the provider | [readonly] |
|
|
8
|
+
| **name** | **String** | The friendly, human-readable name of the provider | [readonly] |
|
|
9
|
+
| **logo_url** | **String** | A URL pointing to the provider's logo | [readonly] |
|
|
10
|
+
| **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | [readonly] |
|
|
11
|
+
| **health** | **String** | The current health status of the provider | [readonly] |
|
|
15
12
|
| **sub_providers** | [**Array<SubProviderMetadata>**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider. For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
|
|
13
|
+
| **regions** | **Array<String>** | The regions a provider is available in. | [readonly] |
|
|
14
|
+
| **countries** | **Array<String>** | A list of countries, in alpha-2 ISO 3166-1 format, that the provider is available in. | [readonly] |
|
|
15
|
+
| **subdivisions** | **Array<String>** | A list of subdivisions, in ISO 3166-2 format, that the provider is available in. | [readonly] |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
19
19
|
```ruby
|
|
20
20
|
require 'trinsic_api'
|
|
21
21
|
|
|
22
|
-
instance = TrinsicApi::
|
|
22
|
+
instance = TrinsicApi::RecommendProviderInformation.new(
|
|
23
23
|
id: null,
|
|
24
24
|
name: null,
|
|
25
25
|
logo_url: null,
|
|
26
26
|
subtext: dmv.ca.gov,
|
|
27
|
-
provider_id: null,
|
|
28
|
-
provider_display_name: null,
|
|
29
|
-
provider_logo: null,
|
|
30
27
|
health: online | offline,
|
|
31
|
-
sub_providers: null
|
|
28
|
+
sub_providers: null,
|
|
29
|
+
regions: null,
|
|
30
|
+
countries: null,
|
|
31
|
+
subdivisions: null
|
|
32
32
|
)
|
|
33
33
|
```
|
|
34
34
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# TrinsicApi::
|
|
1
|
+
# TrinsicApi::RecommendProvidersRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **verification_profile_id** | **String** | The ID of the VerificationProfile to use for this recommendation. | |
|
|
8
8
|
| **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. | [optional] |
|
|
9
|
-
| **health** | **
|
|
9
|
+
| **health** | [**RecommendProviderHealthOption**](RecommendProviderHealthOption.md) | Filter providers by health status. | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'trinsic_api'
|
|
15
15
|
|
|
16
|
-
instance = TrinsicApi::
|
|
16
|
+
instance = TrinsicApi::RecommendProvidersRequest.new(
|
|
17
17
|
verification_profile_id: null,
|
|
18
18
|
recommendation_info: null,
|
|
19
19
|
health: null
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::RecommendProvidersResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **recommended_providers** | [**Array<RecommendProviderInformation>**](RecommendProviderInformation.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::RecommendProvidersResponse.new(
|
|
15
|
+
recommended_providers: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
# TrinsicApi::
|
|
1
|
+
# TrinsicApi::RedirectUrisApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.trinsic.id*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**add**](
|
|
8
|
-
| [**delete**](
|
|
9
|
-
| [**list**](
|
|
7
|
+
| [**add**](RedirectUrisApi.md#add) | **POST** /api/valpha/redirect-uris | Add Redirect URI |
|
|
8
|
+
| [**delete**](RedirectUrisApi.md#delete) | **DELETE** /api/valpha/redirect-uris/{id} | Delete Redirect URI |
|
|
9
|
+
| [**list**](RedirectUrisApi.md#list) | **GET** /api/valpha/redirect-uris | List Redirect URIs |
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
## add
|
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.trinsic.id*
|
|
|
15
15
|
|
|
16
16
|
Add Redirect URI
|
|
17
17
|
|
|
18
|
-
Add a new redirect uri to the environment.
|
|
18
|
+
Add a new redirect uri to the authenticated environment.
|
|
19
19
|
|
|
20
20
|
### Examples
|
|
21
21
|
|
|
@@ -28,9 +28,9 @@ TrinsicApi.configure do |config|
|
|
|
28
28
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
29
|
end
|
|
30
30
|
|
|
31
|
-
api_instance = TrinsicApi::
|
|
31
|
+
api_instance = TrinsicApi::RedirectUrisApi.new
|
|
32
32
|
opts = {
|
|
33
|
-
|
|
33
|
+
add_redirect_uri_request: TrinsicApi::AddRedirectUriRequest.new({uri: 'uri_example'}) # AddRedirectUriRequest | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted.
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
begin
|
|
@@ -38,7 +38,7 @@ begin
|
|
|
38
38
|
result = api_instance.add(opts)
|
|
39
39
|
p result
|
|
40
40
|
rescue TrinsicApi::ApiError => e
|
|
41
|
-
puts "Error when calling
|
|
41
|
+
puts "Error when calling RedirectUrisApi->add: #{e}"
|
|
42
42
|
end
|
|
43
43
|
```
|
|
44
44
|
|
|
@@ -56,7 +56,7 @@ begin
|
|
|
56
56
|
p headers # => { ... }
|
|
57
57
|
p data # => <AddRedirectUriResponse>
|
|
58
58
|
rescue TrinsicApi::ApiError => e
|
|
59
|
-
puts "Error when calling
|
|
59
|
+
puts "Error when calling RedirectUrisApi->add_with_http_info: #{e}"
|
|
60
60
|
end
|
|
61
61
|
```
|
|
62
62
|
|
|
@@ -64,7 +64,7 @@ end
|
|
|
64
64
|
|
|
65
65
|
| Name | Type | Description | Notes |
|
|
66
66
|
| ---- | ---- | ----------- | ----- |
|
|
67
|
-
| **
|
|
67
|
+
| **add_redirect_uri_request** | [**AddRedirectUriRequest**](AddRedirectUriRequest.md) | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted. | [optional] |
|
|
68
68
|
|
|
69
69
|
### Return type
|
|
70
70
|
|
|
@@ -99,14 +99,14 @@ TrinsicApi.configure do |config|
|
|
|
99
99
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
100
100
|
end
|
|
101
101
|
|
|
102
|
-
api_instance = TrinsicApi::
|
|
102
|
+
api_instance = TrinsicApi::RedirectUrisApi.new
|
|
103
103
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the redirect uri to delete.
|
|
104
104
|
|
|
105
105
|
begin
|
|
106
106
|
# Delete Redirect URI
|
|
107
107
|
api_instance.delete(id)
|
|
108
108
|
rescue TrinsicApi::ApiError => e
|
|
109
|
-
puts "Error when calling
|
|
109
|
+
puts "Error when calling RedirectUrisApi->delete: #{e}"
|
|
110
110
|
end
|
|
111
111
|
```
|
|
112
112
|
|
|
@@ -124,7 +124,7 @@ begin
|
|
|
124
124
|
p headers # => { ... }
|
|
125
125
|
p data # => nil
|
|
126
126
|
rescue TrinsicApi::ApiError => e
|
|
127
|
-
puts "Error when calling
|
|
127
|
+
puts "Error when calling RedirectUrisApi->delete_with_http_info: #{e}"
|
|
128
128
|
end
|
|
129
129
|
```
|
|
130
130
|
|
|
@@ -150,11 +150,11 @@ nil (empty response body)
|
|
|
150
150
|
|
|
151
151
|
## list
|
|
152
152
|
|
|
153
|
-
> <
|
|
153
|
+
> <ListRedirectUrisResponse> list(opts)
|
|
154
154
|
|
|
155
155
|
List Redirect URIs
|
|
156
156
|
|
|
157
|
-
List
|
|
157
|
+
List registered Redirect URIs for the authenticated environment
|
|
158
158
|
|
|
159
159
|
### Examples
|
|
160
160
|
|
|
@@ -167,7 +167,7 @@ TrinsicApi.configure do |config|
|
|
|
167
167
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
168
168
|
end
|
|
169
169
|
|
|
170
|
-
api_instance = TrinsicApi::
|
|
170
|
+
api_instance = TrinsicApi::RedirectUrisApi.new
|
|
171
171
|
opts = {
|
|
172
172
|
page: 56, # Integer | Number of pages of uris to return.
|
|
173
173
|
page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
|
|
@@ -178,7 +178,7 @@ begin
|
|
|
178
178
|
result = api_instance.list(opts)
|
|
179
179
|
p result
|
|
180
180
|
rescue TrinsicApi::ApiError => e
|
|
181
|
-
puts "Error when calling
|
|
181
|
+
puts "Error when calling RedirectUrisApi->list: #{e}"
|
|
182
182
|
end
|
|
183
183
|
```
|
|
184
184
|
|
|
@@ -186,7 +186,7 @@ end
|
|
|
186
186
|
|
|
187
187
|
This returns an Array which contains the response data, status code and headers.
|
|
188
188
|
|
|
189
|
-
> <Array(<
|
|
189
|
+
> <Array(<ListRedirectUrisResponse>, Integer, Hash)> list_with_http_info(opts)
|
|
190
190
|
|
|
191
191
|
```ruby
|
|
192
192
|
begin
|
|
@@ -194,9 +194,9 @@ begin
|
|
|
194
194
|
data, status_code, headers = api_instance.list_with_http_info(opts)
|
|
195
195
|
p status_code # => 2xx
|
|
196
196
|
p headers # => { ... }
|
|
197
|
-
p data # => <
|
|
197
|
+
p data # => <ListRedirectUrisResponse>
|
|
198
198
|
rescue TrinsicApi::ApiError => e
|
|
199
|
-
puts "Error when calling
|
|
199
|
+
puts "Error when calling RedirectUrisApi->list_with_http_info: #{e}"
|
|
200
200
|
end
|
|
201
201
|
```
|
|
202
202
|
|
|
@@ -209,7 +209,7 @@ end
|
|
|
209
209
|
|
|
210
210
|
### Return type
|
|
211
211
|
|
|
212
|
-
[**
|
|
212
|
+
[**ListRedirectUrisResponse**](ListRedirectUrisResponse.md)
|
|
213
213
|
|
|
214
214
|
### Authorization
|
|
215
215
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::SamsungWalletProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Samsung Wallet. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::SamsungWalletProviderOutput.new(
|
|
15
|
+
raw_mdl_output: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TrinsicApi::SerbiaIdCardProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **first_name** | **String** | The first name of the verified individual | |
|
|
8
|
+
| **last_name** | **String** | The last name of the verified individual | |
|
|
9
|
+
| **date_of_birth** | **Date** | The date of birth of the verified individual | |
|
|
10
|
+
| **unique_master_citizen_number** | **String** | The 13-digit Serbian Unique Master Citizen Number (\"JMBG\" / \"Jedinstveni Matični Broj Građana\") of the verified individual. This is in the format DDMMYYYRRSSSC, where: - DDMM is the day and month of birth - YYY is the last three digits of the year of birth - RR is the political region code of the region of birth (if born after 1976) or of first registration (if born before 1976) - SSS is a unique sex-specific serial number for individuals born on the same date in the same region - C is a checksum digit If YYY is between 000 and 099, the millennium digit of the year is \"2\"; the individual was born after the year 2000. If YYY is between 800 and 999, the millennium digit of the year is \"1\"; the individual was born before the year 2000. If SSS is between 000 and 499, the individual is male. If SSS is between 500 and 999, the individual is female. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'trinsic_api'
|
|
16
|
+
|
|
17
|
+
instance = TrinsicApi::SerbiaIdCardProviderOutput.new(
|
|
18
|
+
first_name: John,
|
|
19
|
+
last_name: Doe,
|
|
20
|
+
date_of_birth: Tue Dec 10 00:00:00 UTC 1985,
|
|
21
|
+
unique_master_citizen_number: 3006990711231
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/SessionsApi.md
CHANGED
|
@@ -8,9 +8,11 @@ All URIs are relative to *https://api.trinsic.id*
|
|
|
8
8
|
| [**create_direct_provider_session**](SessionsApi.md#create_direct_provider_session) | **POST** /api/v1/sessions/provider/direct | Create Direct Provider Session |
|
|
9
9
|
| [**create_hosted_provider_session**](SessionsApi.md#create_hosted_provider_session) | **POST** /api/v1/sessions/provider/hosted | Create Hosted Provider Session |
|
|
10
10
|
| [**create_widget_session**](SessionsApi.md#create_widget_session) | **POST** /api/v1/sessions/widget | Create Widget Session |
|
|
11
|
+
| [**get_attachment**](SessionsApi.md#get_attachment) | **POST** /api/v1/sessions/{sessionId}/attachments/{attachmentId}/get | Get Attachment |
|
|
11
12
|
| [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get Session |
|
|
12
13
|
| [**get_session_result**](SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
|
|
13
14
|
| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/verification-profiles/{verificationProfileId}/sessions | List Sessions |
|
|
15
|
+
| [**recommend_providers**](SessionsApi.md#recommend_providers) | **POST** /api/v1/sessions/providers/recommend | Recommend Providers |
|
|
14
16
|
| [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
|
|
15
17
|
| [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{sessionId}/step/refresh | Refresh Step Content |
|
|
16
18
|
| [**submit_native_challenge_response**](SessionsApi.md#submit_native_challenge_response) | **POST** /api/v1/sessions/{sessionId}/native-challenge/submit | Submit Native Challenge Response |
|
|
@@ -298,6 +300,81 @@ end
|
|
|
298
300
|
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
299
301
|
|
|
300
302
|
|
|
303
|
+
## get_attachment
|
|
304
|
+
|
|
305
|
+
> <GetAttachmentResponse> get_attachment(session_id, attachment_id, opts)
|
|
306
|
+
|
|
307
|
+
Get Attachment
|
|
308
|
+
|
|
309
|
+
Fetch an Attachment's contents.
|
|
310
|
+
|
|
311
|
+
### Examples
|
|
312
|
+
|
|
313
|
+
```ruby
|
|
314
|
+
require 'time'
|
|
315
|
+
require 'trinsic_api'
|
|
316
|
+
# setup authorization
|
|
317
|
+
TrinsicApi.configure do |config|
|
|
318
|
+
# Configure Bearer authorization: Bearer
|
|
319
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
320
|
+
end
|
|
321
|
+
|
|
322
|
+
api_instance = TrinsicApi::SessionsApi.new
|
|
323
|
+
session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The ID of the Session to fetch the Attachment from
|
|
324
|
+
attachment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The ID of the Attachment to fetch
|
|
325
|
+
opts = {
|
|
326
|
+
get_attachment_request: TrinsicApi::GetAttachmentRequest.new({results_access_key: 'results_access_key_example'}) # GetAttachmentRequest |
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
begin
|
|
330
|
+
# Get Attachment
|
|
331
|
+
result = api_instance.get_attachment(session_id, attachment_id, opts)
|
|
332
|
+
p result
|
|
333
|
+
rescue TrinsicApi::ApiError => e
|
|
334
|
+
puts "Error when calling SessionsApi->get_attachment: #{e}"
|
|
335
|
+
end
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
#### Using the get_attachment_with_http_info variant
|
|
339
|
+
|
|
340
|
+
This returns an Array which contains the response data, status code and headers.
|
|
341
|
+
|
|
342
|
+
> <Array(<GetAttachmentResponse>, Integer, Hash)> get_attachment_with_http_info(session_id, attachment_id, opts)
|
|
343
|
+
|
|
344
|
+
```ruby
|
|
345
|
+
begin
|
|
346
|
+
# Get Attachment
|
|
347
|
+
data, status_code, headers = api_instance.get_attachment_with_http_info(session_id, attachment_id, opts)
|
|
348
|
+
p status_code # => 2xx
|
|
349
|
+
p headers # => { ... }
|
|
350
|
+
p data # => <GetAttachmentResponse>
|
|
351
|
+
rescue TrinsicApi::ApiError => e
|
|
352
|
+
puts "Error when calling SessionsApi->get_attachment_with_http_info: #{e}"
|
|
353
|
+
end
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### Parameters
|
|
357
|
+
|
|
358
|
+
| Name | Type | Description | Notes |
|
|
359
|
+
| ---- | ---- | ----------- | ----- |
|
|
360
|
+
| **session_id** | **String** | The ID of the Session to fetch the Attachment from | |
|
|
361
|
+
| **attachment_id** | **String** | The ID of the Attachment to fetch | |
|
|
362
|
+
| **get_attachment_request** | [**GetAttachmentRequest**](GetAttachmentRequest.md) | | [optional] |
|
|
363
|
+
|
|
364
|
+
### Return type
|
|
365
|
+
|
|
366
|
+
[**GetAttachmentResponse**](GetAttachmentResponse.md)
|
|
367
|
+
|
|
368
|
+
### Authorization
|
|
369
|
+
|
|
370
|
+
[Bearer](../README.md#Bearer)
|
|
371
|
+
|
|
372
|
+
### HTTP request headers
|
|
373
|
+
|
|
374
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
375
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
376
|
+
|
|
377
|
+
|
|
301
378
|
## get_session
|
|
302
379
|
|
|
303
380
|
> <GetSessionResponse> get_session(session_id)
|
|
@@ -517,13 +594,84 @@ end
|
|
|
517
594
|
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
518
595
|
|
|
519
596
|
|
|
597
|
+
## recommend_providers
|
|
598
|
+
|
|
599
|
+
> <RecommendProvidersResponse> recommend_providers(opts)
|
|
600
|
+
|
|
601
|
+
Recommend Providers
|
|
602
|
+
|
|
603
|
+
Recommend providers for a specific user session. You can filter based on health (default=online) and specify country and subdivision information. Trinsic will use the phone number and IP address, if provided, to deduce the country and subdivision of the user and use that info for filtering the providers.
|
|
604
|
+
|
|
605
|
+
### Examples
|
|
606
|
+
|
|
607
|
+
```ruby
|
|
608
|
+
require 'time'
|
|
609
|
+
require 'trinsic_api'
|
|
610
|
+
# setup authorization
|
|
611
|
+
TrinsicApi.configure do |config|
|
|
612
|
+
# Configure Bearer authorization: Bearer
|
|
613
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
614
|
+
end
|
|
615
|
+
|
|
616
|
+
api_instance = TrinsicApi::SessionsApi.new
|
|
617
|
+
opts = {
|
|
618
|
+
recommend_providers_request: TrinsicApi::RecommendProvidersRequest.new({verification_profile_id: 'verification_profile_id_example'}) # RecommendProvidersRequest |
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
begin
|
|
622
|
+
# Recommend Providers
|
|
623
|
+
result = api_instance.recommend_providers(opts)
|
|
624
|
+
p result
|
|
625
|
+
rescue TrinsicApi::ApiError => e
|
|
626
|
+
puts "Error when calling SessionsApi->recommend_providers: #{e}"
|
|
627
|
+
end
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
#### Using the recommend_providers_with_http_info variant
|
|
631
|
+
|
|
632
|
+
This returns an Array which contains the response data, status code and headers.
|
|
633
|
+
|
|
634
|
+
> <Array(<RecommendProvidersResponse>, Integer, Hash)> recommend_providers_with_http_info(opts)
|
|
635
|
+
|
|
636
|
+
```ruby
|
|
637
|
+
begin
|
|
638
|
+
# Recommend Providers
|
|
639
|
+
data, status_code, headers = api_instance.recommend_providers_with_http_info(opts)
|
|
640
|
+
p status_code # => 2xx
|
|
641
|
+
p headers # => { ... }
|
|
642
|
+
p data # => <RecommendProvidersResponse>
|
|
643
|
+
rescue TrinsicApi::ApiError => e
|
|
644
|
+
puts "Error when calling SessionsApi->recommend_providers_with_http_info: #{e}"
|
|
645
|
+
end
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
### Parameters
|
|
649
|
+
|
|
650
|
+
| Name | Type | Description | Notes |
|
|
651
|
+
| ---- | ---- | ----------- | ----- |
|
|
652
|
+
| **recommend_providers_request** | [**RecommendProvidersRequest**](RecommendProvidersRequest.md) | | [optional] |
|
|
653
|
+
|
|
654
|
+
### Return type
|
|
655
|
+
|
|
656
|
+
[**RecommendProvidersResponse**](RecommendProvidersResponse.md)
|
|
657
|
+
|
|
658
|
+
### Authorization
|
|
659
|
+
|
|
660
|
+
[Bearer](../README.md#Bearer)
|
|
661
|
+
|
|
662
|
+
### HTTP request headers
|
|
663
|
+
|
|
664
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
665
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
666
|
+
|
|
667
|
+
|
|
520
668
|
## redact_session
|
|
521
669
|
|
|
522
670
|
> redact_session(session_id)
|
|
523
671
|
|
|
524
672
|
Redact Session
|
|
525
673
|
|
|
526
|
-
Redact a Session, removing all identity data from Trinsic's servers. Every
|
|
674
|
+
Redact a Session, removing all identity data from Trinsic's servers. Every verification profile has a redaction period that dictates how long we will hold on to your users' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
|
|
527
675
|
|
|
528
676
|
### Examples
|
|
529
677
|
|
data/docs/SmartIdInput.md
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **smart_id_document_number** | **String** | The user's Smart ID Document Number | [optional] |
|
|
8
7
|
| **smart_id_number** | **String** | The user's Smart ID ETSI number or document number. | [optional] |
|
|
9
8
|
|
|
10
9
|
## Example
|
|
@@ -13,7 +12,6 @@
|
|
|
13
12
|
require 'trinsic_api'
|
|
14
13
|
|
|
15
14
|
instance = TrinsicApi::SmartIdInput.new(
|
|
16
|
-
smart_id_document_number: null,
|
|
17
15
|
smart_id_number: null
|
|
18
16
|
)
|
|
19
17
|
```
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# TrinsicApi::SmartIdProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **given_name** | **String** | The given name (first name) of the individual, extracted from the Smart ID authentication certificate's Subject Distinguished Name \"G\" (givenName) attribute. | [optional] |
|
|
8
|
+
| **family_name** | **String** | The family name (surname) of the individual, extracted from the Smart ID authentication certificate's Subject Distinguished Name \"SN\" (surname) attribute. | [optional] |
|
|
9
|
+
| **date_of_birth** | **Date** | The individual's date of birth, derived from the personal code. NOTE: Newer Latvian personal codes starting with \"32\" do not contain date of birth information. | [optional] |
|
|
10
|
+
| **sex** | **String** | The individual's sex, derived from the first digit of the personal code. NOTE: Not available for Latvian personal codes. Possible values: - Male - Female | [optional] |
|
|
11
|
+
| **country** | **String** | The ISO 3166-1 alpha-2 country code extracted from the Smart ID authentication certificate's Subject Distinguished Name \"C\" (country) attribute. This represents the country of the certificate issuer, not the person's nationality or citizenship. For Smart ID, this will be \"EE\" (Estonia), \"LT\" (Lithuania), or \"LV\" (Latvia). | [optional] |
|
|
12
|
+
| **identity_type** | **String** | The identity document type, extracted from the first 3 characters of the SERIALNUMBER field (before the country code). Possible values: - PNO: Personal Number (national civic registration number) - PAS: Passport - IDC: National identity card | [optional] |
|
|
13
|
+
| **personal_code** | **String** | The personal code (Estonian: isikukood, Lithuanian: asmens kodas, Latvian: personas kods) of the individual, extracted from the SERIALNUMBER field of the Smart ID authentication certificate. This is the portion after the identity type and country prefix (e.g., \"48501010014\" from \"PNOEE-48501010014\"). Estonian and Lithuanian personal codes are 11 digits in the format GYYMMDDSSSC where: - G = century/gender (3-4 = 1900s, 5-6 = 2000s; odd = male, even = female) - YYMMDD = date of birth - SSS = sequence number - C = checksum digit Latvian personal codes use the format DDMMYY-NNNNN (6 digits, a dash, and 5 digits). See: - https://en.wikipedia.org/wiki/National_identification_number#Estonia - https://en.wikipedia.org/wiki/National_identification_number#Lithuania - https://en.wikipedia.org/wiki/National_identification_number#Latvia | [optional] |
|
|
14
|
+
| **serial_number** | **String** | The SERIALNUMBER attribute from the Smart ID authentication certificate's Subject Distinguished Name. Format: \"{identity-type}{country-code}-{identifier}\" Components: - identity-type (3 chars): PNO (Personal Number), PAS (Passport), IDC (ID Card) - country-code (2 chars): ISO 3166-1 alpha-2 (EE, LT, LV) - identifier: The personal code | [optional] |
|
|
15
|
+
| **certificate_subject** | **String** | The full Subject Distinguished Name (Subject DN) from the Smart ID authentication certificate. Contains comma-separated RDN (Relative Distinguished Name) components including C (Country), CN (Common Name), SN (Surname), G (Given Name), and SERIALNUMBER (Personal identifier). | [optional] |
|
|
16
|
+
| **certificate_level** | **String** | The certificate level indicating the authentication assurance level. Possible values: - QUALIFIED: Highest assurance level (eIDAS QES - Qualified Electronic Signature), legally equivalent to a handwritten signature. This is the standard production level. - ADVANCED: Lower assurance level (eIDAS AdES), also called \"Smart-ID Basic\". Only available in test environments for test accounts. | [optional] |
|
|
17
|
+
| **document_number** | **String** | A unique identifier for the Smart ID account/document used for this authentication. Format: PNO{CC}-{personal-code}-{device-id}-{qualification} Components: - PNO = Personal Number (identity type) - CC = Country code (EE, LT, LV) - personal-code = The individual's personal code - device-id = Random 4-character device identifier - qualification = NQ (non-qualified) or Q (qualified certificate) This is a stable identifier that can be used to recognize returning users across sessions. | [optional] |
|
|
18
|
+
| **interaction_flow_used** | **String** | Indicates which interaction flow was used during the Smart ID authentication process. This reflects which of the allowedInteractionsOrder options was actually used. Possible values: - displayTextAndPIN: User saw text and entered PIN - verificationCodeChoice: User selected from multiple verification codes - confirmationMessage: User confirmed a message - confirmationMessageAndVerificationCodeChoice: Combination of both | [optional] |
|
|
19
|
+
| **device_ip_address** | **String** | The IP address of the device where the Smart ID app was used for authentication. Can be IPv4 or IPv6 format. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'trinsic_api'
|
|
25
|
+
|
|
26
|
+
instance = TrinsicApi::SmartIdProviderOutput.new(
|
|
27
|
+
given_name: MARI,
|
|
28
|
+
family_name: TAMM,
|
|
29
|
+
date_of_birth: Tue Jan 01 00:00:00 UTC 1985,
|
|
30
|
+
sex: Female,
|
|
31
|
+
country: EE,
|
|
32
|
+
identity_type: PNO,
|
|
33
|
+
personal_code: 48501010014,
|
|
34
|
+
serial_number: PNOEE-48501010014,
|
|
35
|
+
certificate_subject: SERIALNUMBER=PNOEE-48501010014, G=MARI, SN=TAMM, CN="TAMM,MARI,48501010014", C=EE,
|
|
36
|
+
certificate_level: QUALIFIED,
|
|
37
|
+
document_number: PNOEE-48501010014-Z1B2-Q,
|
|
38
|
+
interaction_flow_used: displayTextAndPIN,
|
|
39
|
+
device_ip_address: 192.168.1.100
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::SouthAfricaNidBiometric2Input
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_number** | **String** | The user's South African National ID number | [optional] |
|
|
8
|
+
| **liveness_images** | **Array<String>** | An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size. | [optional] |
|
|
9
|
+
| **test_selfie** | **String** | Test selfie for test environment (optional, maximum 15MB). Must be JPEG format. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::SouthAfricaNidBiometric2Input.new(
|
|
17
|
+
id_number: null,
|
|
18
|
+
liveness_images: null,
|
|
19
|
+
test_selfie: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# TrinsicApi::SouthAfricaNidMatch2Input
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_number** | **String** | The user's South African National ID number | [optional] |
|
|
8
|
+
| **given_name** | **String** | The user's first name as it appears in their National ID | [optional] |
|
|
9
|
+
| **family_name** | **String** | The user's last name as it appears in their National ID | [optional] |
|
|
10
|
+
| **middle_name** | **String** | The user's middle name as it appears in their National ID (optional) | [optional] |
|
|
11
|
+
| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
|
|
12
|
+
| **sex** | [**SouthAfricaNidMatch2InputSex**](SouthAfricaNidMatch2InputSex.md) | The user's sex as it appears in their National ID | [optional] |
|
|
13
|
+
| **phone_number** | **String** | The user's phone number as it appears in their National ID (optional). Must be in E.164 international format: \"+27XXXXXXXXX\" | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'trinsic_api'
|
|
19
|
+
|
|
20
|
+
instance = TrinsicApi::SouthAfricaNidMatch2Input.new(
|
|
21
|
+
id_number: null,
|
|
22
|
+
given_name: null,
|
|
23
|
+
family_name: null,
|
|
24
|
+
middle_name: null,
|
|
25
|
+
date_of_birth: null,
|
|
26
|
+
sex: null,
|
|
27
|
+
phone_number: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# TrinsicApi::SouthAfricaNidMatch2InputSex
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'trinsic_api'
|
|
12
|
+
|
|
13
|
+
instance = TrinsicApi::SouthAfricaNidMatch2InputSex.new()
|
|
14
|
+
```
|
|
15
|
+
|