trinsic_api 1.1.2 → 2.0.0.pre.alpha3

data/docs/NetworkApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://api.trinsic.id*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**identity_lookup**](NetworkApi.md#identity_lookup) | **GET** /api/v1/network/identities/{phoneNumber} | Lookup Identity |
 | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Identity Providers |
+| [**recommend_providers**](NetworkApi.md#recommend_providers) | **POST** /api/v1/network/recommend | Recommend Providers |
 
 
-## identity_lookup
+## list_providers
 
-> <IdentityLookupResponse> identity_lookup(phone_number)
+> <ListProvidersResponse> list_providers
 
-Lookup Identity
+List Identity Providers
 
-Query the availability of an identity in the Trinsic Network by phone number
+List all identity providers available for use
 
 ### Examples
 
@@ -28,44 +28,41 @@ TrinsicApi.configure do |config|
 end
 
 api_instance = TrinsicApi::NetworkApi.new
-phone_number = 'phone_number_example' # String | 
 
 begin
-  # Lookup Identity
-  result = api_instance.identity_lookup(phone_number)
+  # List Identity Providers
+  result = api_instance.list_providers
   p result
 rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->identity_lookup: #{e}"
+  puts "Error when calling NetworkApi->list_providers: #{e}"
 end
 ```
 
-#### Using the identity_lookup_with_http_info variant
+#### Using the list_providers_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<IdentityLookupResponse>, Integer, Hash)> identity_lookup_with_http_info(phone_number)
+> <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info
 
 ```ruby
 begin
-  # Lookup Identity
-  data, status_code, headers = api_instance.identity_lookup_with_http_info(phone_number)
+  # List Identity Providers
+  data, status_code, headers = api_instance.list_providers_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <IdentityLookupResponse>
+  p data # => <ListProvidersResponse>
 rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->identity_lookup_with_http_info: #{e}"
+  puts "Error when calling NetworkApi->list_providers_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **phone_number** | **String** |  |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**IdentityLookupResponse**](IdentityLookupResponse.md)
+[**ListProvidersResponse**](ListProvidersResponse.md)
 
 ### Authorization
 
@@ -77,13 +74,13 @@ end
 - **Accept**: text/plain, application/json, text/json
 
 
-## list_providers
+## recommend_providers
 
-> <ListProvidersResponse> list_providers
+> <RecommendResponse> recommend_providers(opts)
 
-List Identity Providers
+Recommend Providers
 
-List all identity providers available for use
+Generate provider recommendations based on the given signals (phone number, countries, states).
 
 ### Examples
 
@@ -97,41 +94,46 @@ TrinsicApi.configure do |config|
 end
 
 api_instance = TrinsicApi::NetworkApi.new
+opts = {
+  recommend_request: TrinsicApi::RecommendRequest.new # RecommendRequest | 
+}
 
 begin
-  # List Identity Providers
-  result = api_instance.list_providers
+  # Recommend Providers
+  result = api_instance.recommend_providers(opts)
   p result
 rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->list_providers: #{e}"
+  puts "Error when calling NetworkApi->recommend_providers: #{e}"
 end
 ```
 
-#### Using the list_providers_with_http_info variant
+#### Using the recommend_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
+> <Array(<RecommendResponse>, Integer, Hash)> recommend_providers_with_http_info(opts)
 
 ```ruby
 begin
-  # List Identity Providers
-  data, status_code, headers = api_instance.list_providers_with_http_info
+  # Recommend Providers
+  data, status_code, headers = api_instance.recommend_providers_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <ListProvidersResponse>
+  p data # => <RecommendResponse>
 rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->list_providers_with_http_info: #{e}"
+  puts "Error when calling NetworkApi->recommend_providers_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recommend_request** | [**RecommendRequest**](RecommendRequest.md) |  | [optional] |
 
 ### Return type
 
-[**ListProvidersResponse**](ListProvidersResponse.md)
+[**RecommendResponse**](RecommendResponse.md)
 
 ### Authorization
 
@@ -139,6 +141,6 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json, text/json, application/*+json
 - **Accept**: text/plain, application/json, text/json
 

data/docs/NigeriaNinInput.md

@@ -0,0 +1,30 @@
+# TrinsicApi::NigeriaNinInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The user's first name as it appears in their National ID |  |
+| **middle_name** | **String** | The user's middle name as it appears in their National ID (optional) | [optional] |
+| **last_name** | **String** | The user's last name as it appears in their National ID (optional) |  |
+| **phone_number** | **String** | The user's phone number (optional) | [optional] |
+| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format |  |
+| **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) | [optional] |
+| **national_id_number** | **String** | The user's South African National ID number |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::NigeriaNinInput.new(
+  first_name: null,
+  middle_name: null,
+  last_name: null,
+  phone_number: null,
+  date_of_birth: null,
+  gender: null,
+  national_id_number: null
+)
+```
+

data/docs/PersonData.md

@@ -4,15 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **given_name** | **String** | Given (first) name of the individual | [optional] |
-| **family_name** | **String** | Family (last) name of the individual | [optional] |
-| **middle_name** | **String** | Middle name of the individual | [optional] |
-| **full_name** | **String** | The individual's full name as a single string.                Useful for names which do not fit into a \"first middle last\" structure. | [optional] |
+| **given_name** | **String** |  | [optional] |
+| **family_name** | **String** |  | [optional] |
+| **middle_name** | **String** |  | [optional] |
+| **full_name** | **String** |  | [optional] |
+| **suffix** | **String** |  | [optional] |
 | **nationality** | **String** |  | [optional] |
-| **gender** | **String** |  | [optional] |
+| **sex** | [**Sex**](Sex.md) |  | [optional] |
 | **phone_number** | **String** |  | [optional] |
-| **address** | [**Address**](Address.md) | Address information for an individual | [optional] |
-| **date_of_birth** | **String** |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **date_of_birth** | **Date** |  | [optional] |
 
 ## Example
 
@@ -20,12 +21,13 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::PersonData.new(
-  given_name: John,
-  family_name: Doe,
-  middle_name: Jacob,
-  full_name: John Jacob de Doe,
+  given_name: null,
+  family_name: null,
+  middle_name: null,
+  full_name: null,
+  suffix: null,
   nationality: null,
-  gender: null,
+  sex: null,
   phone_number: null,
   address: null,
   date_of_birth: null

data/docs/PhilippineMatchInput.md

@@ -0,0 +1,26 @@
+# TrinsicApi::PhilippineMatchInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | The user's given / first name | [optional] |
+| **middle_name** | **String** | The user's middle name | [optional] |
+| **family_name** | **String** | The user's family / last name | [optional] |
+| **suffix** | **String** | The user's name suffix | [optional] |
+| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PhilippineMatchInput.new(
+  given_name: null,
+  middle_name: null,
+  family_name: null,
+  suffix: null,
+  date_of_birth: null
+)
+```
+

data/docs/PhilippineQRInput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::PhilippineQRInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **qr_code_text** | **String** | The raw text of the user's QR code after decoding it. | [optional] |
+| **qr_code_image** | **String** | The raw bytes of the image containing the user's QR code. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PhilippineQRInput.new(
+  qr_code_text: null,
+  qr_code_image: null
+)
+```
+

data/docs/ProblemDetails.md

@@ -0,0 +1,26 @@
+# TrinsicApi::ProblemDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **status** | **Integer** |  | [optional] |
+| **detail** | **String** |  | [optional] |
+| **instance** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProblemDetails.new(
+  type: null,
+  title: null,
+  status: null,
+  detail: null,
+  instance: null
+)
+```
+

data/docs/ProviderAttachments.md

@@ -0,0 +1,18 @@
+# TrinsicApi::ProviderAttachments
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_scan** | [**DocumentScanAttachments**](DocumentScanAttachments.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderAttachments.new(
+  document_scan: null
+)
+```
+

data/docs/ProviderInfo.md

@@ -7,6 +7,7 @@
 | **id** | **String** | The ID of the provider |  |
 | **name** | **String** | The friendly, human-readable name of the provider |  |
 | **logo_url** | **String** | A URL pointing to the provider's logo |  |
+| **child_provider_ids** | **Array<String>** | List of child provider id's where the provider allows deep-launching of a specific provider. | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'trinsic_api'
 instance = TrinsicApi::ProviderInfo.new(
   id: yoti | clear | ...,
   name: Yoti | CLEAR | ...,
-  logo_url: null
+  logo_url: null,
+  child_provider_ids: null
 )
 ```
 

data/docs/ProviderInformation.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ProviderInformation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_id** | **String** |  |  |
+| **provider_display_name** | **String** |  |  |
+| **provider_logo** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderInformation.new(
+  provider_id: null,
+  provider_display_name: null,
+  provider_logo: null
+)
+```
+

data/docs/ProviderInput.md

@@ -0,0 +1,38 @@
+# TrinsicApi::ProviderInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `f-indonesia-nik` integration | [optional] |
+| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `f-mexico-curp` integration | [optional] |
+| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `f-south-africa-nid` integration | [optional] |
+| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `f-kenya-nid` integration | [optional] |
+| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `f-nigeria-nin` integration | [optional] |
+| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `f-india-aadhaar-match` integration | [optional] |
+| **bangladesh_national_id** | [**BangladeshNationalIdInput**](BangladeshNationalIdInput.md) | Input for the `bangladesh-nid` integration | [optional] |
+| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `g-brazil-cpf` integration | [optional] |
+| **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `g-brazil-digital-cnh` integration | [optional] |
+| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `b-philsys-biometric` integration | [optional] |
+| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` integrations | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderInput.new(
+  indonesia_nik: null,
+  mexico_curp: null,
+  south_africa_nid: null,
+  kenya_nid: null,
+  nigeria_nin: null,
+  aadhaar: null,
+  bangladesh_national_id: null,
+  brazil_cpf_check: null,
+  brazil_digital_cnh: null,
+  philippine_match: null,
+  philippine_qr: null
+)
+```
+

data/docs/RecommendRequest.md

@@ -0,0 +1,26 @@
+# TrinsicApi::RecommendRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | The phone number of the user you wish to generate a recommendation for. Will be used to look up the user's identity in the network | [optional] |
+| **countries** | **Array<String>** | A list of countries, in alpha-2 ISO 3166 format, you wish to specify for the recommendation, this can include the user's country of residence, nationality, etc. | [optional] |
+| **subdivisions** | **Array<String>** | If one of the countries has subdivisions, for example the US states, you can specify a list of these to further refine the recommendation (e.g., CA, UT, NY) | [optional] |
+| **ip_addresses** | **Array<String>** | Provide the IP addresses of the user you wish to generate a recommendation for. Will be used to look up the user's geographic location. | [optional] |
+| **include_disabled_providers** | **Boolean** | If true, the recommendation will include providers that are disabled for the app | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RecommendRequest.new(
+  phone_number: null,
+  countries: null,
+  subdivisions: null,
+  ip_addresses: null,
+  include_disabled_providers: null
+)
+```
+

data/docs/RecommendResponse.md

@@ -0,0 +1,22 @@
+# TrinsicApi::RecommendResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recognized** | [**Array<ProviderInformation>**](ProviderInformation.md) | The list of providers that were recognized in Trinsic's network. These are providers that already verified this user |  |
+| **relevant** | [**Array<ProviderInformation>**](ProviderInformation.md) | The list of providers that although not recognized, are relevant to the user's identity. The user may have been verified by these providers |  |
+| **remainder** | [**Array<ProviderInformation>**](ProviderInformation.md) | The list of providers that are not recognized and are not relevant to the user's identity |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RecommendResponse.new(
+  recognized: null,
+  relevant: null,
+  remainder: null
+)
+```
+

data/docs/RefreshStepContentRequest.md

@@ -0,0 +1,18 @@
+# TrinsicApi::RefreshStepContentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results_access_key** | **String** | The `ResultsAccessKey` returned when the Session was created | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RefreshStepContentRequest.new(
+  results_access_key: null
+)
+```
+

data/docs/RefreshStepContentResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::RefreshStepContentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_step** | [**IntegrationStep**](IntegrationStep.md) | The integration's next step with refreshed content |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RefreshStepContentResponse.new(
+  next_step: null
+)
+```
+

data/docs/ResultCollection.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ResultCollection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | The method by which the results of the Acceptance Session should be collected. |  |
+| **results_access_key** | **String** | If the method is `PollResult`, this is the key that should be used to poll for the results. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ResultCollection.new(
+  method: null,
+  results_access_key: null
+)
+```
+

data/docs/ResultCollectionMethod.md

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

data/docs/Session.md

@@ -5,10 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **state** | [**SessionState**](SessionState.md) | The state of the session |  |
-| **fail_code** | [**SessionFailCode**](SessionFailCode.md) | If the session is in state `IdvFailed`, this field contains the reason for failure. | [optional] |
-| **verification** | [**Verification**](Verification.md) | The underlying verification for this Session |  |
-| **disclosed_fields** | [**DisclosedFields**](DisclosedFields.md) | The fields that were requested to be disclosed when the Session was created |  |
+| **done** | **Boolean** | Whether the Session is in a terminal / final state.                If this is `true`, inspect the value of `Success` to determine whether the Session was successful. |  |
+| **success** | **Boolean** | Whether the Session has completed successfully.                If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information.  If this is `true`, the Session has completed successfully. |  |
+| **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session's failure.                Only present if `Success` is `false`. | [optional] |
 | **created** | **Integer** | The unix timestamp, in seconds, when this session was created |  |
 | **updated** | **Integer** | The unix timestamp, in seconds, when this session's state last changed |  |
 
@@ -19,10 +18,9 @@ require 'trinsic_api'
 
 instance = TrinsicApi::Session.new(
   id: 678c1ff6-2178-49e7-81d2-548afb6f85ec,
-  state: null,
-  fail_code: null,
-  verification: null,
-  disclosed_fields: null,
+  done: null,
+  success: null,
+  error_code: null,
   created: 1722526411,
   updated: 1722526722
 )

data/docs/{VerificationFailCode.md → SessionErrorCode.md}

@@ -1,4 +1,4 @@
-# TrinsicApi::VerificationFailCode
+# TrinsicApi::SessionErrorCode
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::VerificationFailCode.new()
+instance = TrinsicApi::SessionErrorCode.new()
 ```