trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/docs/PeruDniProviderOutput.md

@@ -0,0 +1,48 @@
+# TrinsicApi::PeruDniProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**PeruDniAddress**](PeruDniAddress.md) | Information about the general area in which the DNI holder resides.              This field is not always available. | [optional] |
+| **array_name** | **Array<String>** | All names that appear on DNI, as an array of strings.              Format: - All uppercase - Ordered by paternal family name, then maternal family name, then given names. |  |
+| **civil_status** | **String** | Marital status as it appears on the DNI.              This field is not always available.              Valid values: - \"Single\" - \"Married\" - \"Divorced\" - \"Widowed\" | [optional] |
+| **date_of_birth** | **Date** | Date of birth as it appears on the DNI.              This field is not always available. | [optional] |
+| **document_number** | **String** | The user's National Identity Document number (Documento Nacional de Identidad or DNI).              Format: - 8 digits - Does NOT include verification digit. On the DNI card, a ninth digit appears next to the first eight. It is   0-9 or A-K. This is NOT included in the DNI number when returned from Peru's database. - Does NOT include dots or hyphens |  |
+| **document_type** | **String** | Should always be \"DNI\". |  |
+| **expedition_date** | **Date** | Date that the DNI was issued.              This field is not always available.              Format: - yyyy-MM-dd | [optional] |
+| **expiration_date** | **Date** | Date that the DNI will expire. DNI expires every 8 years, unless the citizen is >= 60 years old, in which case it never expires.              This field is not always available.              Format: - yyyy-MM-dd | [optional] |
+| **first_name** | **String** | Given names as they appear on DNI.              Format: - All uppercase - Space-separated - Will include all given names |  |
+| **full_name** | **String** | All names as they appear on DNI.              Format: - All uppercase - Space-separated - Will include all names, given and family - Ordered by given names first, then paternal family name, then maternal family name |  |
+| **last_name** | **String** | Family names as they appear on DNI.              Format: - All uppercase - Will include all family names - Ordered by paternal family name first, then maternal family name |  |
+| **maternal_last_name** | **String** | Maternal last name as it appears on DNI.              Format: - All uppercase |  |
+| **paternal_last_name** | **String** | Paternal last name as it appears on DNI.              Format: - All uppercase |  |
+| **sex** | **String** | Sex as it appears on DNI.              This field is not always available.              Values: - \"Male\" - \"Female\" | [optional] |
+| **ubigeo_reniec** | **String** | In Peru, geographical locations have an official geographical code called UBIGEO, from the spanish \"UBIcación GEOgráfica\" (Geographic Location). This is an administrative geocode, is different from a postal code (which Peru also has) and is used to specifically delineate the administrative region, province and district hierarchy.              There are two coding systems for UBIGEO: one from INEI (National Institute of Statistics and Informatics) and another from RENIEC (National Registry of Identification and Civil Status). The two coding systems are similar but are not 100% the same (some numbers will map to different geographic locations). This field follows the coding system from RENIEC.              This field is not always available.              Format: - Always 6 digits - First two digits represent region - Middle two are province - Last two are district              Given the example 081304, that would correspond to: - 08 - Cusco Region - 0813 - Urubamba Province - 081304 - Machupicchu District | [optional] |
+| **verification_digit** | **String** | The final (ninth) digit of the DNI, which serves as a checksum over the first eight digits.              This field is not always available.              Format: - Single character - Either 0-9 or A-K              Read more here:   https://elcomercio.pe/mag/respuestas/cual-es-el-digito-verificador-de-mi-dni-documento-nacional-de-identidad-reniec-peru-nnda-nnlt-noticia/ | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PeruDniProviderOutput.new(
+  address: null,
+  array_name: ["QUISPE","MAMANI","JUAN","CARLOS"],
+  civil_status: Single,
+  date_of_birth: Thu Jan 14 00:00:00 UTC 1999,
+  document_number: 19050215,
+  document_type: DNI,
+  expedition_date: Tue Jan 14 00:00:00 UTC 2025,
+  expiration_date: Fri Jan 14 00:00:00 UTC 2033,
+  first_name: JUAN CARLOS,
+  full_name: JUAN CARLOS QUISPE MAMANI,
+  last_name: QUISPE MAMANI,
+  maternal_last_name: MAMANI,
+  paternal_last_name: QUISPE,
+  sex: Male,
+  ubigeo_reniec: 081304,
+  verification_digit: 7
+)
+```
+

data/docs/PhilippinesDigitalNidProviderOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **philsys_card_number** | **String** | The PhilSys card number. |  |
+| **philsys_card_number** | **String** | The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between. |  |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::PhilippinesDigitalNidProviderOutput.new(
-  philsys_card_number: null
+  philsys_card_number: 1234-5678-9101-1213
 )
 ```
 

data/docs/PhilippinesPhysicalNidProviderOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **philsys_card_number** | **String** | The PhilSys card number. |  |
+| **philsys_card_number** | **String** | The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between. |  |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::PhilippinesPhysicalNidProviderOutput.new(
-  philsys_card_number: null
+  philsys_card_number: 1234-5678-9101-1213
 )
 ```
 

data/docs/PolandEdoAppProviderOutput.md

@@ -0,0 +1,24 @@
+# TrinsicApi::PolandEdoAppProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The first name of the verified individual |  |
+| **last_name** | **String** | The last name of the verified individual |  |
+| **date_of_birth** | **Date** | The date of birth of the verified individual |  |
+| **national_identification_number** | **String** | The 11-digit Polish national identification number (PESEL) of the verified individual.              This is in the format YYMMDDZZZGQ, where: - YYMMDD is the date of birth - ZZZ is a unique identifier - G is sex (even for females, odd for males) - Q is a checksum digit              The year of birth encoded in this identifier assumes a default year of birth in the 20th century. If the year of birth is in the range [1800, 1899], the month portion is incremented by 80. If the year of birth is in the range [2000, 2099] the month portion is incremented by 20. If the year of birth is in the range [2100, 2199], the month portion is incremented by 40. If the year of birth is in the range [2200, 2299], the month portion is incremented by 60. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PolandEdoAppProviderOutput.new(
+  first_name: John,
+  last_name: Doe,
+  date_of_birth: Tue Dec 10 00:00:00 UTC 1985,
+  national_identification_number: 90063014513
+)
+```
+

data/docs/PolandMojeIdProviderOutput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::PolandMojeIdProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The first name of the verified individual |  |
+| **last_name** | **String** | The last name of the verified individual |  |
+| **national_identification_number** | **String** | The 11-digit Polish national identification number (PESEL) of the verified individual.              This is in the format YYMMDDZZZGQ, where: - YYMMDD is the date of birth - ZZZ is a unique identifier - G is sex (even for females, odd for males) - Q is a checksum digit              The year of birth encoded in this identifier assumes a default year of birth in the 20th century. If the year of birth is in the range [1800, 1899], the month portion is incremented by 80. If the year of birth is in the range [2000, 2099] the month portion is incremented by 20. If the year of birth is in the range [2100, 2199], the month portion is incremented by 40. If the year of birth is in the range [2200, 2299], the month portion is incremented by 60. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PolandMojeIdProviderOutput.new(
+  first_name: John,
+  last_name: Doe,
+  national_identification_number: 90063014513
+)
+```
+

data/docs/PortugalIdCardProviderOutput.md

@@ -0,0 +1,24 @@
+# TrinsicApi::PortugalIdCardProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The first name of the verified individual |  |
+| **last_name** | **String** | The last name of the verified individual |  |
+| **date_of_birth** | **Date** | The date of birth of the verified individual |  |
+| **civil_identification_number** | **String** | The 8-digit Portuguese Civil Identification Number (número de identificação civil) of the verified individual. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PortugalIdCardProviderOutput.new(
+  first_name: John,
+  last_name: Doe,
+  date_of_birth: Tue Dec 10 00:00:00 UTC 1985,
+  civil_identification_number: 12345678
+)
+```
+

data/docs/PostOfficeEasyIdProviderOutput.md

@@ -0,0 +1,40 @@
+# TrinsicApi::PostOfficeEasyIdProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remember_me_id** | **String** | The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service. | [optional] |
+| **email** | **String** | The email address of the individual | [optional] |
+| **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
+| **family_name** | **String** | The family name of the individual | [optional] |
+| **full_name** | **String** | Full name of the individual which is composed of the given and family name. Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
+| **gender** | **String** | The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.              Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". In some countries Possible values: - \"MALE\" - \"FEMALE\" - \"TRANSGENDER\" - \"OTHER\" | [optional] |
+| **nationality** | **String** | The nationality of the individual as a ISO alpha-3 code | [optional] |
+| **mobile_number** | **String** | The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity. | [optional] |
+| **structured_postal_address** | [**YotiStructuredPostalAddress**](YotiStructuredPostalAddress.md) | A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
+| **postal_address** | **String** | The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". The format of this will be different for each country. Refer to `StructuredPostalAddress` for a detailed version of the address. | [optional] |
+| **document_details** | [**YotiDocumentDetails**](YotiDocumentDetails.md) | The details of the underlying document used to help create the Yoti credential | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PostOfficeEasyIdProviderOutput.new(
+  remember_me_id: 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  email: johndoe@example.com,
+  given_name: John Alvin,
+  family_name: Doe,
+  full_name: John Alvin Doe,
+  date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
+  gender: MALE,
+  nationality: GBR,
+  mobile_number: +447777123456,
+  structured_postal_address: null,
+  postal_address: 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
+  document_details: null
+)
+```
+

data/docs/{ProviderContract.md → Provider.md}

@@ -1,56 +1,60 @@
-# TrinsicApi::ProviderContract
+# TrinsicApi::Provider
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The ID of the Provider for this contract. |  |
-| **name** | **String** | The Provider's Name as it appears in Trinsic's Dashboard and Widget |  |
+| **id** | **String** | The unique identifier of the provider |  |
+| **name** | **String** | The display name of the provider |  |
+| **logo_url** | **String** | The URL of the provider's logo |  |
 | **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. |  |
-| **description** | **String** | The Provider's description as it appears in Trinsic's Widget.              This is flavor text, not a full, human-readable description of the provider. |  |
-| **logo_url** | **String** | A URL pointing to the Provider's logo on Trinsic's CDN.              May be a PNG, JPG, or SVG image. |  |
-| **available** | **Boolean** | Whether the Provider is available for use in your App.              If `false`, you will need to contact Trinsic to enable this Provider for your App. |  |
-| **geography** | **Array<String>** | The geographies within the Regions the Provider is available. |  |
-| **regions** | **Array<String>** | The regions within which the Provider is available. |  |
+| **description** | **String** | A description of the provider's capabilities | [readonly] |
+| **geography** | **Array<String>** | Geographic regions where this provider operates |  |
+| **regions** | **Array<String>** | Specific regions supported by this provider |  |
+| **countries** | **Array<String>** | The countries where this Provider is available (as alpha-2 ISO codes). |  |
+| **subdivisions** | **Array<String>** | The subdivisions (states, provinces, etc.) where this Provider is available (as alpha-2 ISO codes). |  |
+| **licensed** | **Boolean** | Whether this provider is licensed for use by your organization |  |
 | **launch_method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | Relevant only to Direct Provider Sessions.              The `LaunchMethod` which must be supported to launch the Provider Session in Direct Provider Sessions. |  |
 | **collection_method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | Relevant only to Direct Provider Sessions.              The `CollectionMethod` which must be supported to launch the Provider Session in Direct Provider Sessions. |  |
 | **results_may_be_delayed_after_redirect** | **Boolean** | If `true`, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the `GetSessionResults` API must be called until results are available.              This is an uncommon scenario, and only applies to Providers which cannot guarantee the availability of results immediately after the user is redirected back to your application. |  |
 | **has_refreshable_content** | **Boolean** | Relevant only to Direct Provider Sessions.              Whether the Provider requires the `RefreshStepContent` capability.              For example, Samsung Wallet's deep links expire every 30 seconds, and must be refreshed periodically for a resilient user flow. |  |
 | **requires_input** | **Boolean** | Relevant to Hosted Provider Sessions and Direct Provider Sessions.              If `true`, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic's Hosted UI will be invoked to collect the input from the user. |  |
 | **has_trinsic_interface** | **Boolean** | Whether there exists a Trinsic-hosted UI for this Provider.              This is `true` for any Provider which is not a simple, OIDC-like redirect flow. |  |
-| **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. |  |
 | **supports_direct_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. |  |
-| **available_fields** | [**Array<ContractField>**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
-| **available_identifiers** | [**Array<ContractIdentifierField>**](ContractIdentifierField.md) | Information about the identifiers this Provider returns in verification results. | [optional] |
-| **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] |
-| **health** | [**ProviderHealth**](ProviderHealth.md) | The health for an integration to be able to successfully perform a verification session. |  |
+| **available_attributes** | [**Array<ContractAttribute>**](ContractAttribute.md) | Information about the user attributes that this Provider will return in verification results. | [optional] |
+| **available_attachments** | [**Array<ContractAttachment>**](ContractAttachment.md) | Information about the attachments that this Provider will return in verification results. | [optional] |
+| **sub_providers** | [**Array<SubProviderMetadata>**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider in the current Environment.              For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
+| **live_health** | [**ProviderHealth**](ProviderHealth.md) | The health for a provider in the live environment |  |
+| **test_health** | [**ProviderHealth**](ProviderHealth.md) | The health for a provider in the test environment |  |
 
 ## Example
 
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::ProviderContract.new(
-  id: usa-california-dmv,
-  name: CA DMV,
+instance = TrinsicApi::Provider.new(
+  id: yoti,
+  name: Yoti,
+  logo_url: https://cdn.trinsic.id/providers/yoti.png,
   subtext: dmv.ca.gov,
-  description: dmv.ca.gov,
-  logo_url: https://content.trinsic.id/connect/integrations/ca-dmv.png,
-  available: true,
-  geography: ["CA"],
-  regions: ["United States"],
+  description: Identity verification via government ID and biometrics,
+  geography: ["Global"],
+  regions: ["Europe"],
+  countries: ["US","CA"],
+  subdivisions: ["US-CA","US-TX"],
+  licensed: true,
   launch_method: null,
   collection_method: null,
   results_may_be_delayed_after_redirect: false,
   has_refreshable_content: false,
   requires_input: false,
   has_trinsic_interface: true,
-  supports_advanced_provider_sessions: true,
   supports_direct_provider_sessions: true,
-  available_fields: null,
-  available_identifiers: null,
+  available_attributes: null,
+  available_attachments: null,
   sub_providers: null,
-  health: null
+  live_health: null,
+  test_health: null
 )
 ```
 

data/docs/ProviderInput.md

@@ -4,28 +4,37 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **kenya_biometric2** | [**KenyaNidBiometric2Input**](KenyaNidBiometric2Input.md) | Input for the `kenya-nid-match-biometric-2` provider | [optional] |
-| **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `indonesia-nik-lookup` provider | [optional] |
+| **kenya_nid_match_biometric_2** | [**KenyaNidBiometric2Input**](KenyaNidBiometric2Input.md) | Input for the `kenya-nid-match-biometric-2` provider | [optional] |
+| **indonesia_nik_lookup** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `indonesia-nik-lookup` provider | [optional] |
 | **indonesia_dukcapil_match** | [**IndonesiaDukcapilMatchInput**](IndonesiaDukcapilMatchInput.md) | Input for the `indonesia-dukcapil-match` provider | [optional] |
-| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `mexico-curp-lookup` provider | [optional] |
-| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `south-africa-nid-lookup` provider | [optional] |
-| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `kenya-nid-lookup` provider | [optional] |
-| **kenya_nid_match2** | [**KenyaNidMatch2Input**](KenyaNidMatch2Input.md) | Input for the `kenya-nid-match-2` provider | [optional] |
-| **kenya_nid_lookup2** | [**KenyaNidLookup2Input**](KenyaNidLookup2Input.md) | Input for the `kenya-nid-lookup-2` provider | [optional] |
-| **south_africa_nid_lookup2** | [**SouthAfricaNidLookup2Input**](SouthAfricaNidLookup2Input.md) | Input for the `south-africa-nid-lookup-2` provider | [optional] |
-| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `nigeria-nin-lookup` provider | [optional] |
-| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `india-digilocker-aadhaar-match` provider | [optional] |
-| **bangladesh_national_id** | [**BangladeshNidInput**](BangladeshNidInput.md) | Input for the `bangladesh-nid` provider | [optional] |
-| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `brazil-cpf-lookup` provider | [optional] |
+| **mexico_curp_lookup** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `mexico-curp-lookup` provider | [optional] |
+| **south_africa_nid_lookup** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `south-africa-nid-lookup` provider | [optional] |
+| **kenya_nid_lookup** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `kenya-nid-lookup` provider | [optional] |
+| **kenya_nid_match_2** | [**KenyaNidMatch2Input**](KenyaNidMatch2Input.md) | Input for the `kenya-nid-match-2` provider | [optional] |
+| **kenya_nid_lookup_2** | [**KenyaNidLookup2Input**](KenyaNidLookup2Input.md) | Input for the `kenya-nid-lookup-2` provider | [optional] |
+| **south_africa_nid_lookup_2** | [**SouthAfricaNidLookup2Input**](SouthAfricaNidLookup2Input.md) | Input for the `south-africa-nid-lookup-2` provider | [optional] |
+| **south_africa_nid_match_2** | [**SouthAfricaNidMatch2Input**](SouthAfricaNidMatch2Input.md) | Input for the `south-africa-nid-match-2` provider | [optional] |
+| **south_africa_nid_match_biometric_2** | [**SouthAfricaNidBiometric2Input**](SouthAfricaNidBiometric2Input.md) | Input for the `south-africa-nid-match-biometric-2` provider | [optional] |
+| **nigeria_nin_lookup_2** | [**NigeriaNinLookup2Input**](NigeriaNinLookup2Input.md) | Input for the `nigeria-nin-lookup-2` provider | [optional] |
+| **cote_divoire_nid_lookup_2** | [**CoteDIvoireNidLookup2Input**](CoteDIvoireNidLookup2Input.md) | Input for the `cote-divoire-nid-lookup-2` provider | [optional] |
+| **zimbabwe_nid_lookup_2** | [**ZimbabweNidLookup2Input**](ZimbabweNidLookup2Input.md) | Input for the `zimbabwe-nid-lookup-2` provider | [optional] |
+| **nigeria_nin_match_2** | [**NigeriaNinMatch2Input**](NigeriaNinMatch2Input.md) | Input for the `nigeria-nin-match-2` provider | [optional] |
+| **uganda_nid_match_2** | [**UgandaNidMatch2Input**](UgandaNidMatch2Input.md) | Input for the `uganda-nid-match-2` provider | [optional] |
+| **nigeria_nin_match_biometric_2** | [**NigeriaNinBiometric2Input**](NigeriaNinBiometric2Input.md) | Input for the `nigeria-nin-match-biometric-2` provider | [optional] |
+| **nigeria_nin_lookup** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `nigeria-nin-lookup` provider | [optional] |
+| **india_digilocker_aadhaar_match** | [**AadhaarInput**](AadhaarInput.md) | Input for the `india-digilocker-aadhaar-match` provider | [optional] |
+| **brazil_cpf_lookup** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `brazil-cpf-lookup` provider | [optional] |
 | **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `brazil-digital-cnh` provider | [optional] |
-| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `philippines-philsys-match` provider | [optional] |
-| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `philippines-digital-national-id-qr` and `philippines-physical-national-id-qr` providers | [optional] |
+| **philippines_philsys_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `philippines-philsys-match` provider | [optional] |
+| **philippines_physical_national_id_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `philippines-physical-national-id-qr` provider | [optional] |
+| **philippines_digital_national_id_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `philippines-digital-national-id-qr` provider | [optional] |
 | **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the `smart-id` provider | [optional] |
 | **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the `mobile-id` provider | [optional] |
-| **idin** | [**IdinInput**](IdinInput.md) | Input for the `netherlands-idin` provider | [optional] |
-| **spid** | [**SpidInput**](SpidInput.md) | Input for the `italy-spid` provider | [optional] |
+| **netherlands_idin** | [**IdinInput**](IdinInput.md) | Input for the `netherlands-idin` provider | [optional] |
+| **italy_spid** | [**SpidInput**](SpidInput.md) | Input for the `italy-spid` provider | [optional] |
 | **google_wallet** | [**GoogleWalletInput**](GoogleWalletInput.md) | Input for the `google-wallet` provider | [optional] |
 | **apple_wallet** | [**AppleWalletInput**](AppleWalletInput.md) | Input for the `apple-wallet` provider | [optional] |
+| **peru_dni_lookup** | [**PeruDniLookupInput**](PeruDniLookupInput.md) | Input for the `peru-dni-lookup` provider | [optional] |
 | **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.*              Input for the `trinsic-test-database-lookup` provider | [optional] |
 | **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.*              Input for the `trinsic-test-sub-providers` provider | [optional] |
 
@@ -35,28 +44,37 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::ProviderInput.new(
-  kenya_biometric2: null,
-  indonesia_nik: null,
+  kenya_nid_match_biometric_2: null,
+  indonesia_nik_lookup: null,
   indonesia_dukcapil_match: null,
-  mexico_curp: null,
-  south_africa_nid: null,
-  kenya_nid: null,
-  kenya_nid_match2: null,
-  kenya_nid_lookup2: null,
-  south_africa_nid_lookup2: null,
-  nigeria_nin: null,
-  aadhaar: null,
-  bangladesh_national_id: null,
-  brazil_cpf_check: null,
+  mexico_curp_lookup: null,
+  south_africa_nid_lookup: null,
+  kenya_nid_lookup: null,
+  kenya_nid_match_2: null,
+  kenya_nid_lookup_2: null,
+  south_africa_nid_lookup_2: null,
+  south_africa_nid_match_2: null,
+  south_africa_nid_match_biometric_2: null,
+  nigeria_nin_lookup_2: null,
+  cote_divoire_nid_lookup_2: null,
+  zimbabwe_nid_lookup_2: null,
+  nigeria_nin_match_2: null,
+  uganda_nid_match_2: null,
+  nigeria_nin_match_biometric_2: null,
+  nigeria_nin_lookup: null,
+  india_digilocker_aadhaar_match: null,
+  brazil_cpf_lookup: null,
   brazil_digital_cnh: null,
-  philippine_match: null,
-  philippine_qr: null,
+  philippines_philsys_match: null,
+  philippines_physical_national_id_qr: null,
+  philippines_digital_national_id_qr: null,
   smart_id: null,
   mobile_id: null,
-  idin: null,
-  spid: null,
+  netherlands_idin: null,
+  italy_spid: null,
   google_wallet: null,
   apple_wallet: null,
+  peru_dni_lookup: null,
   trinsic_test_database_lookup: null,
   trinsic_test_sub_providers: null
 )

data/docs/ProviderOutput.md

@@ -4,11 +4,38 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) |  | [optional] |
-| **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) |  | [optional] |
-| **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) |  | [optional] |
-| **philippines_physical_national_id_qr** | [**PhilippinesPhysicalNidProviderOutput**](PhilippinesPhysicalNidProviderOutput.md) |  | [optional] |
-| **philippines_digital_national_id_qr** | [**PhilippinesDigitalNidProviderOutput**](PhilippinesDigitalNidProviderOutput.md) |  | [optional] |
+| **a_at_handy_signatur_login** | [**AustriaHandySignaturProviderOutput**](AustriaHandySignaturProviderOutput.md) | Exposed properties for the `a-at-handy-signatur-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_be_id_login** | [**BelgiumIdCardProviderOutput**](BelgiumIdCardProviderOutput.md) | Exposed properties for the `a-be-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_edoapp_eid_login** | [**PolandEdoAppProviderOutput**](PolandEdoAppProviderOutput.md) | Exposed properties for the `a-edoapp-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_ee_web_eid_login** | [**EstoniaIdCardProviderOutput**](EstoniaIdCardProviderOutput.md) | Exposed properties for the `a-ee-web-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_fi_id_login** | [**FinlandIdCardProviderOutput**](FinlandIdCardProviderOutput.md) | Exposed properties for the `a-fi-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_freja_eid_login** | [**FrejaProviderOutput**](FrejaProviderOutput.md) | Exposed properties for the `a-freja-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_itsme_login** | [**ItsmeProviderOutput**](ItsmeProviderOutput.md) | Exposed properties for the `a-itsme-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_lt_id_login** | [**LithuaniaIdCardProviderOutput**](LithuaniaIdCardProviderOutput.md) | Exposed properties for the `a-lt-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_lv_eparaksts_id_login** | [**LatviaEparakstsProviderOutput**](LatviaEparakstsProviderOutput.md) | Exposed properties for the `a-lv-eparaksts-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_lv_eparaksts_mobile_login** | [**LatviaEparakstsMobileProviderOutput**](LatviaEparakstsMobileProviderOutput.md) | Exposed properties for the `a-lv-eparaksts-mobile-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_mojeid** | [**CzechiaMojeIdProviderOutput**](CzechiaMojeIdProviderOutput.md) | Exposed properties for the `a-mojeid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_pl_mojeid_login** | [**PolandMojeIdProviderOutput**](PolandMojeIdProviderOutput.md) | Exposed properties for the `a-pl-mojeid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_pt_id_login** | [**PortugalIdCardProviderOutput**](PortugalIdCardProviderOutput.md) | Exposed properties for the `a-pt-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **a_rs_id_login** | [**SerbiaIdCardProviderOutput**](SerbiaIdCardProviderOutput.md) | Exposed properties for the `a-rs-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **apple_wallet** | [**AppleWalletProviderOutput**](AppleWalletProviderOutput.md) | Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **denmark_mitid** | [**MitIdProviderOutput**](MitIdProviderOutput.md) | Exposed properties for the `denmark-mitid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) | Exposed properties for the `ethiopia-fayda` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **france_identite_numerique** | [**FrenchNumeriqueProviderOutput**](FrenchNumeriqueProviderOutput.md) | Exposed properties for the `france-identite-numerique` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **google_wallet** | [**GoogleWalletProviderOutput**](GoogleWalletProviderOutput.md) | Exposed properties for the `google-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) | Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **lloyds_smart_id** | [**LloydsSmartIdProviderOutput**](LloydsSmartIdProviderOutput.md) | Exposed properties for the `lloyds-smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) | Exposed properties for the `mexico-curp-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **mobile_id** | [**MobileIdProviderOutput**](MobileIdProviderOutput.md) | Exposed properties for the `mobile-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **peru_dni_lookup** | [**PeruDniProviderOutput**](PeruDniProviderOutput.md) | Exposed properties for the `peru-dni-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **philippines_digital_national_id_qr** | [**PhilippinesDigitalNidProviderOutput**](PhilippinesDigitalNidProviderOutput.md) | Exposed properties for the `philippines-digital-national-id-qr` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **philippines_physical_national_id_qr** | [**PhilippinesPhysicalNidProviderOutput**](PhilippinesPhysicalNidProviderOutput.md) | Exposed properties for the `philippines-physical-national-id-qr` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **post_office_easyid** | [**PostOfficeEasyIdProviderOutput**](PostOfficeEasyIdProviderOutput.md) | Exposed properties for the `post-office-easyid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **samsung_wallet** | [**SamsungWalletProviderOutput**](SamsungWalletProviderOutput.md) | Exposed properties for the `samsung-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **smart_id** | [**SmartIdProviderOutput**](SmartIdProviderOutput.md) | Exposed properties for the `smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **sweden_bankid** | [**SwedenBankIdProviderOutput**](SwedenBankIdProviderOutput.md) | Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **usa_louisiana_wallet** | [**LaWalletProviderOutput**](LaWalletProviderOutput.md) | Exposed properties for the `usa-louisiana-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
+| **yoti** | [**YotiProviderOutput**](YotiProviderOutput.md) | Exposed properties for the `yoti` Provider which do not directly map to the normalized IdentityData model. | [optional] |
 
 ## Example
 
@@ -16,11 +43,38 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::ProviderOutput.new(
+  a_at_handy_signatur_login: null,
+  a_be_id_login: null,
+  a_edoapp_eid_login: null,
+  a_ee_web_eid_login: null,
+  a_fi_id_login: null,
+  a_freja_eid_login: null,
+  a_itsme_login: null,
+  a_lt_id_login: null,
+  a_lv_eparaksts_id_login: null,
+  a_lv_eparaksts_mobile_login: null,
+  a_mojeid: null,
+  a_pl_mojeid_login: null,
+  a_pt_id_login: null,
+  a_rs_id_login: null,
+  apple_wallet: null,
+  denmark_mitid: null,
+  ethiopia_fayda: null,
+  france_identite_numerique: null,
+  google_wallet: null,
   italy_spid: null,
+  lloyds_smart_id: null,
   mexico_curp_lookup: null,
-  ethiopia_fayda: null,
+  mobile_id: null,
+  peru_dni_lookup: null,
+  philippines_digital_national_id_qr: null,
   philippines_physical_national_id_qr: null,
-  philippines_digital_national_id_qr: null
+  post_office_easyid: null,
+  samsung_wallet: null,
+  smart_id: null,
+  sweden_bankid: null,
+  usa_louisiana_wallet: null,
+  yoti: null
 )
 ```
 

data/docs/ProvidersApi.md

@@ -0,0 +1,79 @@
+# TrinsicApi::ProvidersApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_providers**](ProvidersApi.md#list_providers) | **GET** /api/v1/providers | List Providers |
+
+
+## list_providers
+
+> <ListProvidersResponse> list_providers(opts)
+
+List Providers
+
+List all identity providers available to your Organization, including their license status.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::ProvidersApi.new
+opts = {
+  licensed: true # Boolean | Filter by license status. If not specified, returns all providers.
+}
+
+begin
+  # List Providers
+  result = api_instance.list_providers(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling ProvidersApi->list_providers: #{e}"
+end
+```
+
+#### Using the list_providers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info(opts)
+
+```ruby
+begin
+  # List Providers
+  data, status_code, headers = api_instance.list_providers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListProvidersResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling ProvidersApi->list_providers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **licensed** | **Boolean** | Filter by license status. If not specified, returns all providers. | [optional] |
+
+### Return type
+
+[**ListProvidersResponse**](ListProvidersResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+

data/docs/RecommendProviderHealthOption.md

@@ -0,0 +1,15 @@
+# TrinsicApi::RecommendProviderHealthOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RecommendProviderHealthOption.new()
+```
+