trinsic_api 2.2.0.pre.alpha1 → 2.3.0.pre.alpha1
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/AddRedirectUriResponse.md +18 -0
- data/docs/ContractField.md +2 -0
- data/docs/ContractIdentifierField.md +22 -0
- data/docs/CreateVerificationProfileResponse.md +18 -0
- data/docs/EnvironmentRedirectUrisAddRequest.md +18 -0
- data/docs/EnvironmentRedirectUrisApi.md +222 -0
- data/docs/FaydaProviderOutput.md +18 -0
- data/docs/Identifier.md +22 -0
- data/docs/IdentityData.md +5 -1
- data/docs/ListEnvironmentRedirectUrisResponse.md +20 -0
- data/docs/ListVerificationProfilesResponse.md +20 -0
- data/docs/MexicoCurpProviderOutput.md +18 -0
- data/docs/NetworkApi.md +7 -5
- data/docs/ProviderContract.md +2 -0
- data/docs/ProviderOutput.md +22 -0
- data/docs/RedirectUriResponse.md +20 -0
- data/docs/SessionsApi.md +14 -14
- data/docs/SpidBillingInformation.md +22 -0
- data/docs/SpidInput.md +3 -1
- data/docs/SpidProviderOutput.md +26 -0
- data/docs/VerificationProfileResponse.md +28 -0
- data/docs/VerificationProfilesApi.md +231 -0
- data/lib/trinsic_api/api/environment_redirect_uris_api.rb +228 -0
- data/lib/trinsic_api/api/network_api.rb +6 -2
- data/lib/trinsic_api/api/sessions_api.rb +18 -18
- data/lib/trinsic_api/api/verification_profiles_api.rb +273 -0
- data/lib/trinsic_api/models/add_redirect_uri_response.rb +237 -0
- data/lib/trinsic_api/models/contract_field.rb +28 -1
- data/lib/trinsic_api/models/contract_identifier_field.rb +315 -0
- data/lib/trinsic_api/models/create_verification_profile_response.rb +238 -0
- data/lib/trinsic_api/models/environment_redirect_uris_add_request.rb +237 -0
- data/lib/trinsic_api/models/fayda_provider_output.rb +222 -0
- data/lib/trinsic_api/models/identifier.rb +289 -0
- data/lib/trinsic_api/models/identity_data.rb +43 -5
- data/lib/trinsic_api/models/list_environment_redirect_uris_response.rb +268 -0
- data/lib/trinsic_api/models/list_verification_profiles_response.rb +266 -0
- data/lib/trinsic_api/models/mexico_curp_provider_output.rb +222 -0
- data/lib/trinsic_api/models/provider_contract.rb +14 -1
- data/lib/trinsic_api/models/provider_output.rb +241 -0
- data/lib/trinsic_api/models/redirect_uri_response.rb +263 -0
- data/lib/trinsic_api/models/spid_billing_information.rb +293 -0
- data/lib/trinsic_api/models/spid_input.rb +16 -5
- data/lib/trinsic_api/models/spid_provider_output.rb +266 -0
- data/lib/trinsic_api/models/verification_profile_response.rb +375 -0
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +16 -0
- data/spec/api/environment_redirect_uris_api_spec.rb +72 -0
- data/spec/api/network_api_spec.rb +3 -1
- data/spec/api/sessions_api_spec.rb +2 -2
- data/spec/api/verification_profiles_api_spec.rb +76 -0
- data/spec/models/add_redirect_uri_response_spec.rb +36 -0
- data/spec/models/contract_field_spec.rb +6 -0
- data/spec/models/contract_identifier_field_spec.rb +48 -0
- data/spec/models/create_verification_profile_response_spec.rb +36 -0
- data/spec/models/environment_redirect_uris_add_request_spec.rb +36 -0
- data/spec/models/fayda_provider_output_spec.rb +36 -0
- data/spec/models/identifier_spec.rb +48 -0
- data/spec/models/identity_data_spec.rb +12 -0
- data/spec/models/list_environment_redirect_uris_response_spec.rb +42 -0
- data/spec/models/list_verification_profiles_response_spec.rb +42 -0
- data/spec/models/mexico_curp_provider_output_spec.rb +36 -0
- data/spec/models/provider_contract_spec.rb +6 -0
- data/spec/models/provider_output_spec.rb +48 -0
- data/spec/models/redirect_uri_response_spec.rb +42 -0
- data/spec/models/spid_billing_information_spec.rb +48 -0
- data/spec/models/spid_input_spec.rb +6 -0
- data/spec/models/spid_provider_output_spec.rb +60 -0
- data/spec/models/verification_profile_response_spec.rb +66 -0
- metadata +66 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 26f9e70f0a127486cf561fa90e9b89a4344e6afe56c1a4cb36770623b61b0af7
|
|
4
|
+
data.tar.gz: 52e4df967dfcd364b11b63c6f9ac4e0274a604a3b33a09253e63af6a94bcd028
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 20c8e01b1b83df0b5dfd193b50981fa9bce7e43ca3a8de1a0a4c57f4ec0481b582091b51ecd0818937bb1cf86be4f4317ac62b96f2583b130d5e2f18a891a907
|
|
7
|
+
data.tar.gz: 3fae13cb18c93d822708acf0f6b6b04fd1e03682b7f331571f51c8d72206a83fb3513a6ab893420f04c21f21fb234d5706a14558f3b8edb9d1cbf3e95d2a8ad7
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::AddRedirectUriResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::AddRedirectUriResponse.new(
|
|
15
|
+
id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/ContractField.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | The name of the field as it appears in verification results. | |
|
|
8
|
+
| **scope** | **String** | The scope of the field as it appears in verification results. | |
|
|
8
9
|
| **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. | |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
@@ -14,6 +15,7 @@ require 'trinsic_api'
|
|
|
14
15
|
|
|
15
16
|
instance = TrinsicApi::ContractField.new(
|
|
16
17
|
name: person.givenName,
|
|
18
|
+
scope: person.givenName,
|
|
17
19
|
outputted: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::ContractIdentifierField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **scope** | **String** | The scope of the identifier as it appears in verification results. | |
|
|
8
|
+
| **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. | |
|
|
9
|
+
| **description** | **String** | A human-readable description of the identifier, written by Trinsic. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::ContractIdentifierField.new(
|
|
17
|
+
scope: vatNumber,
|
|
18
|
+
outputted: null,
|
|
19
|
+
description: Italian fiscal number from the SPID identity
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::CreateVerificationProfileResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The ID of the verification profile | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::CreateVerificationProfileResponse.new(
|
|
15
|
+
id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::EnvironmentRedirectUrisAddRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **uri** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::EnvironmentRedirectUrisAddRequest.new(
|
|
15
|
+
uri: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
# TrinsicApi::EnvironmentRedirectUrisApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.trinsic.id*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add**](EnvironmentRedirectUrisApi.md#add) | **POST** /api/valpha/environments/redirect-uris | Add Redirect URI |
|
|
8
|
+
| [**delete**](EnvironmentRedirectUrisApi.md#delete) | **DELETE** /api/valpha/environments/redirect-uris/{id} | Delete Redirect URI |
|
|
9
|
+
| [**list**](EnvironmentRedirectUrisApi.md#list) | **GET** /api/valpha/environments/redirect-uris | List Redirect URIs |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## add
|
|
13
|
+
|
|
14
|
+
> <AddRedirectUriResponse> add(opts)
|
|
15
|
+
|
|
16
|
+
Add Redirect URI
|
|
17
|
+
|
|
18
|
+
Add a new redirect uri to the environment.
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'trinsic_api'
|
|
25
|
+
# setup authorization
|
|
26
|
+
TrinsicApi.configure do |config|
|
|
27
|
+
# Configure Bearer authorization: Bearer
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = TrinsicApi::EnvironmentRedirectUrisApi.new
|
|
32
|
+
opts = {
|
|
33
|
+
environment_redirect_uris_add_request: TrinsicApi::EnvironmentRedirectUrisAddRequest.new({uri: 'uri_example'}) # EnvironmentRedirectUrisAddRequest | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted.
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
# Add Redirect URI
|
|
38
|
+
result = api_instance.add(opts)
|
|
39
|
+
p result
|
|
40
|
+
rescue TrinsicApi::ApiError => e
|
|
41
|
+
puts "Error when calling EnvironmentRedirectUrisApi->add: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Using the add_with_http_info variant
|
|
46
|
+
|
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
|
48
|
+
|
|
49
|
+
> <Array(<AddRedirectUriResponse>, Integer, Hash)> add_with_http_info(opts)
|
|
50
|
+
|
|
51
|
+
```ruby
|
|
52
|
+
begin
|
|
53
|
+
# Add Redirect URI
|
|
54
|
+
data, status_code, headers = api_instance.add_with_http_info(opts)
|
|
55
|
+
p status_code # => 2xx
|
|
56
|
+
p headers # => { ... }
|
|
57
|
+
p data # => <AddRedirectUriResponse>
|
|
58
|
+
rescue TrinsicApi::ApiError => e
|
|
59
|
+
puts "Error when calling EnvironmentRedirectUrisApi->add_with_http_info: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **environment_redirect_uris_add_request** | [**EnvironmentRedirectUrisAddRequest**](EnvironmentRedirectUrisAddRequest.md) | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted. | [optional] |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**AddRedirectUriResponse**](AddRedirectUriResponse.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[Bearer](../README.md#Bearer)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
|
80
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## delete
|
|
84
|
+
|
|
85
|
+
> delete(id)
|
|
86
|
+
|
|
87
|
+
Delete Redirect URI
|
|
88
|
+
|
|
89
|
+
Delete a redirect uri from the environment.
|
|
90
|
+
|
|
91
|
+
### Examples
|
|
92
|
+
|
|
93
|
+
```ruby
|
|
94
|
+
require 'time'
|
|
95
|
+
require 'trinsic_api'
|
|
96
|
+
# setup authorization
|
|
97
|
+
TrinsicApi.configure do |config|
|
|
98
|
+
# Configure Bearer authorization: Bearer
|
|
99
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
api_instance = TrinsicApi::EnvironmentRedirectUrisApi.new
|
|
103
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the redirect uri to delete.
|
|
104
|
+
|
|
105
|
+
begin
|
|
106
|
+
# Delete Redirect URI
|
|
107
|
+
api_instance.delete(id)
|
|
108
|
+
rescue TrinsicApi::ApiError => e
|
|
109
|
+
puts "Error when calling EnvironmentRedirectUrisApi->delete: #{e}"
|
|
110
|
+
end
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### Using the delete_with_http_info variant
|
|
114
|
+
|
|
115
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
116
|
+
|
|
117
|
+
> <Array(nil, Integer, Hash)> delete_with_http_info(id)
|
|
118
|
+
|
|
119
|
+
```ruby
|
|
120
|
+
begin
|
|
121
|
+
# Delete Redirect URI
|
|
122
|
+
data, status_code, headers = api_instance.delete_with_http_info(id)
|
|
123
|
+
p status_code # => 2xx
|
|
124
|
+
p headers # => { ... }
|
|
125
|
+
p data # => nil
|
|
126
|
+
rescue TrinsicApi::ApiError => e
|
|
127
|
+
puts "Error when calling EnvironmentRedirectUrisApi->delete_with_http_info: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Name | Type | Description | Notes |
|
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
|
135
|
+
| **id** | **String** | The id of the redirect uri to delete. | |
|
|
136
|
+
|
|
137
|
+
### Return type
|
|
138
|
+
|
|
139
|
+
nil (empty response body)
|
|
140
|
+
|
|
141
|
+
### Authorization
|
|
142
|
+
|
|
143
|
+
[Bearer](../README.md#Bearer)
|
|
144
|
+
|
|
145
|
+
### HTTP request headers
|
|
146
|
+
|
|
147
|
+
- **Content-Type**: Not defined
|
|
148
|
+
- **Accept**: application/problem+json
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
## list
|
|
152
|
+
|
|
153
|
+
> <ListEnvironmentRedirectUrisResponse> list(opts)
|
|
154
|
+
|
|
155
|
+
List Redirect URIs
|
|
156
|
+
|
|
157
|
+
List redirect URIs within the environment.
|
|
158
|
+
|
|
159
|
+
### Examples
|
|
160
|
+
|
|
161
|
+
```ruby
|
|
162
|
+
require 'time'
|
|
163
|
+
require 'trinsic_api'
|
|
164
|
+
# setup authorization
|
|
165
|
+
TrinsicApi.configure do |config|
|
|
166
|
+
# Configure Bearer authorization: Bearer
|
|
167
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
api_instance = TrinsicApi::EnvironmentRedirectUrisApi.new
|
|
171
|
+
opts = {
|
|
172
|
+
page: 56, # Integer | Number of pages of uris to return.
|
|
173
|
+
page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
begin
|
|
177
|
+
# List Redirect URIs
|
|
178
|
+
result = api_instance.list(opts)
|
|
179
|
+
p result
|
|
180
|
+
rescue TrinsicApi::ApiError => e
|
|
181
|
+
puts "Error when calling EnvironmentRedirectUrisApi->list: #{e}"
|
|
182
|
+
end
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
#### Using the list_with_http_info variant
|
|
186
|
+
|
|
187
|
+
This returns an Array which contains the response data, status code and headers.
|
|
188
|
+
|
|
189
|
+
> <Array(<ListEnvironmentRedirectUrisResponse>, Integer, Hash)> list_with_http_info(opts)
|
|
190
|
+
|
|
191
|
+
```ruby
|
|
192
|
+
begin
|
|
193
|
+
# List Redirect URIs
|
|
194
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
|
195
|
+
p status_code # => 2xx
|
|
196
|
+
p headers # => { ... }
|
|
197
|
+
p data # => <ListEnvironmentRedirectUrisResponse>
|
|
198
|
+
rescue TrinsicApi::ApiError => e
|
|
199
|
+
puts "Error when calling EnvironmentRedirectUrisApi->list_with_http_info: #{e}"
|
|
200
|
+
end
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
| Name | Type | Description | Notes |
|
|
206
|
+
| ---- | ---- | ----------- | ----- |
|
|
207
|
+
| **page** | **Integer** | Number of pages of uris to return. | [optional][default to 1] |
|
|
208
|
+
| **page_size** | **Integer** | Size of the list to be returned. Accepted range from 1 to 100 | [optional][default to 20] |
|
|
209
|
+
|
|
210
|
+
### Return type
|
|
211
|
+
|
|
212
|
+
[**ListEnvironmentRedirectUrisResponse**](ListEnvironmentRedirectUrisResponse.md)
|
|
213
|
+
|
|
214
|
+
### Authorization
|
|
215
|
+
|
|
216
|
+
[Bearer](../README.md#Bearer)
|
|
217
|
+
|
|
218
|
+
### HTTP request headers
|
|
219
|
+
|
|
220
|
+
- **Content-Type**: Not defined
|
|
221
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
|
222
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::FaydaProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **sub** | **String** | A unique eKYC identifying token used to match the original eKYC token received from the provider when the user was initially registered. Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique user token received from Fayda when the user was initially registered to do a comparison of the subs to verify that it is the same person. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::FaydaProviderOutput.new(
|
|
15
|
+
sub: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/Identifier.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::Identifier
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **identifier** | **String** | | |
|
|
8
|
+
| **scope** | **String** | | |
|
|
9
|
+
| **description** | **String** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::Identifier.new(
|
|
17
|
+
identifier: null,
|
|
18
|
+
scope: null,
|
|
19
|
+
description: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/IdentityData.md
CHANGED
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
| **document** | [**DocumentData**](DocumentData.md) | | [optional] |
|
|
11
11
|
| **match** | [**MatchData**](MatchData.md) | | [optional] |
|
|
12
12
|
| **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) | | [optional] |
|
|
13
|
+
| **provider_output** | [**ProviderOutput**](ProviderOutput.md) | | [optional] |
|
|
14
|
+
| **identifiers** | [**Array<Identifier>**](Identifier.md) | | |
|
|
13
15
|
|
|
14
16
|
## Example
|
|
15
17
|
|
|
@@ -22,7 +24,9 @@ instance = TrinsicApi::IdentityData.new(
|
|
|
22
24
|
person: null,
|
|
23
25
|
document: null,
|
|
24
26
|
match: null,
|
|
25
|
-
attachment_access_keys: null
|
|
27
|
+
attachment_access_keys: null,
|
|
28
|
+
provider_output: null,
|
|
29
|
+
identifiers: null
|
|
26
30
|
)
|
|
27
31
|
```
|
|
28
32
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::ListEnvironmentRedirectUrisResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **uris** | [**Array<RedirectUriResponse>**](RedirectUriResponse.md) | List of redirect uris within the environment. | |
|
|
8
|
+
| **more** | **Boolean** | Whether there are additional pages of uris to retrieve | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::ListEnvironmentRedirectUrisResponse.new(
|
|
16
|
+
uris: null,
|
|
17
|
+
more: true
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::ListVerificationProfilesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **verification_profiles** | [**Array<VerificationProfileResponse>**](VerificationProfileResponse.md) | | |
|
|
8
|
+
| **more** | **Boolean** | Whether there are additional pages of verification profiles to retrieve | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::ListVerificationProfilesResponse.new(
|
|
16
|
+
verification_profiles: null,
|
|
17
|
+
more: true
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::MexicoCurpProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **curp_status** | **String** | Curp status for the subject. Possible values: - AN: Alta Normal (Normal registration) - Active - AH: Alta con Homonimia (Registration with homonymy) - Active - RCC: Registro de cambio afectando a CURP (Change affecting CURP) - Active - RCN: Registro de cambio no afectando a CURP (Change not affecting CURP) - Active - BAP: Baja por documento apócrifo (Low due to apocryphal document) - Inactive - BSU: Baja sin uso (Low curp without use) - Inactive - BD: Baja por defunción (Low curp due to death) - Inactive - BDM: Baja administrativa (Low, due to administrative process) - Inactive - BDP: Baja por adopción (Low, due to adoption) - Inactive - BJD: Baja Judicial (Low for judicial reasons) - Inactive | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::MexicoCurpProviderOutput.new(
|
|
15
|
+
curp_status: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/NetworkApi.md
CHANGED
|
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.trinsic.id*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**list_provider_contracts**](NetworkApi.md#list_provider_contracts) | **GET** /api/v1/network/{verificationProfileId}/providers/contracts | List Provider Contracts |
|
|
8
|
-
| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/{verificationProfileId}/providers |
|
|
8
|
+
| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/{verificationProfileId}/providers | List Providers |
|
|
9
9
|
| [**recommend_providers**](NetworkApi.md#recommend_providers) | **POST** /api/v1/network/recommend | Recommend Providers |
|
|
10
10
|
|
|
11
11
|
|
|
@@ -82,7 +82,9 @@ end
|
|
|
82
82
|
|
|
83
83
|
> <ListProvidersResponse> list_providers(verification_profile_id, opts)
|
|
84
84
|
|
|
85
|
+
List Providers
|
|
85
86
|
|
|
87
|
+
List all identity providers available for use
|
|
86
88
|
|
|
87
89
|
### Examples
|
|
88
90
|
|
|
@@ -98,11 +100,11 @@ end
|
|
|
98
100
|
api_instance = TrinsicApi::NetworkApi.new
|
|
99
101
|
verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
100
102
|
opts = {
|
|
101
|
-
health: 'health_example' # String |
|
|
103
|
+
health: 'health_example' # String | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"all\".
|
|
102
104
|
}
|
|
103
105
|
|
|
104
106
|
begin
|
|
105
|
-
|
|
107
|
+
# List Providers
|
|
106
108
|
result = api_instance.list_providers(verification_profile_id, opts)
|
|
107
109
|
p result
|
|
108
110
|
rescue TrinsicApi::ApiError => e
|
|
@@ -118,7 +120,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
118
120
|
|
|
119
121
|
```ruby
|
|
120
122
|
begin
|
|
121
|
-
|
|
123
|
+
# List Providers
|
|
122
124
|
data, status_code, headers = api_instance.list_providers_with_http_info(verification_profile_id, opts)
|
|
123
125
|
p status_code # => 2xx
|
|
124
126
|
p headers # => { ... }
|
|
@@ -133,7 +135,7 @@ end
|
|
|
133
135
|
| Name | Type | Description | Notes |
|
|
134
136
|
| ---- | ---- | ----------- | ----- |
|
|
135
137
|
| **verification_profile_id** | **String** | | |
|
|
136
|
-
| **health** | **String** |
|
|
138
|
+
| **health** | **String** | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"all\". | [optional] |
|
|
137
139
|
|
|
138
140
|
### Return type
|
|
139
141
|
|
data/docs/ProviderContract.md
CHANGED
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
| **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. | |
|
|
22
22
|
| **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. | |
|
|
23
23
|
| **available_fields** | [**Array<ContractField>**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
|
|
24
|
+
| **available_identifiers** | [**Array<ContractIdentifierField>**](ContractIdentifierField.md) | Information about the identifiers this Provider returns in verification results. | [optional] |
|
|
24
25
|
| **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] |
|
|
25
26
|
| **health** | [**ProviderHealth**](ProviderHealth.md) | The health for an integration to be able to successfully perform a verification session. | |
|
|
26
27
|
|
|
@@ -47,6 +48,7 @@ instance = TrinsicApi::ProviderContract.new(
|
|
|
47
48
|
supports_advanced_provider_sessions: true,
|
|
48
49
|
supports_direct_provider_sessions: true,
|
|
49
50
|
available_fields: null,
|
|
51
|
+
available_identifiers: null,
|
|
50
52
|
sub_providers: null,
|
|
51
53
|
health: null
|
|
52
54
|
)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::ProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) | | [optional] |
|
|
8
|
+
| **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) | | [optional] |
|
|
9
|
+
| **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::ProviderOutput.new(
|
|
17
|
+
italy_spid: null,
|
|
18
|
+
mexico_curp_lookup: null,
|
|
19
|
+
ethiopia_fayda: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::RedirectUriResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **uri** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::RedirectUriResponse.new(
|
|
16
|
+
id: null,
|
|
17
|
+
uri: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/SessionsApi.md
CHANGED
|
@@ -12,8 +12,8 @@ All URIs are relative to *https://api.trinsic.id*
|
|
|
12
12
|
| [**get_session_result**](SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
|
|
13
13
|
| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/verification-profiles/{verificationProfileId}/sessions | List Sessions |
|
|
14
14
|
| [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
|
|
15
|
-
| [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{
|
|
16
|
-
| [**submit_native_challenge_response**](SessionsApi.md#submit_native_challenge_response) | **POST** /api/v1/sessions/{
|
|
15
|
+
| [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{sessionId}/step/refresh | Refresh Step Content |
|
|
16
|
+
| [**submit_native_challenge_response**](SessionsApi.md#submit_native_challenge_response) | **POST** /api/v1/sessions/{sessionId}/native-challenge/submit | Submit Native Challenge Response |
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
## cancel_session
|
|
@@ -587,7 +587,7 @@ nil (empty response body)
|
|
|
587
587
|
|
|
588
588
|
## refresh_step_content
|
|
589
589
|
|
|
590
|
-
> <RefreshStepContentResponse> refresh_step_content(
|
|
590
|
+
> <RefreshStepContentResponse> refresh_step_content(session_id, opts)
|
|
591
591
|
|
|
592
592
|
Refresh Step Content
|
|
593
593
|
|
|
@@ -605,14 +605,14 @@ TrinsicApi.configure do |config|
|
|
|
605
605
|
end
|
|
606
606
|
|
|
607
607
|
api_instance = TrinsicApi::SessionsApi.new
|
|
608
|
-
|
|
608
|
+
session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
609
609
|
opts = {
|
|
610
610
|
refresh_step_content_request: TrinsicApi::RefreshStepContentRequest.new({results_access_key: 'results_access_key_example'}) # RefreshStepContentRequest |
|
|
611
611
|
}
|
|
612
612
|
|
|
613
613
|
begin
|
|
614
614
|
# Refresh Step Content
|
|
615
|
-
result = api_instance.refresh_step_content(
|
|
615
|
+
result = api_instance.refresh_step_content(session_id, opts)
|
|
616
616
|
p result
|
|
617
617
|
rescue TrinsicApi::ApiError => e
|
|
618
618
|
puts "Error when calling SessionsApi->refresh_step_content: #{e}"
|
|
@@ -623,12 +623,12 @@ end
|
|
|
623
623
|
|
|
624
624
|
This returns an Array which contains the response data, status code and headers.
|
|
625
625
|
|
|
626
|
-
> <Array(<RefreshStepContentResponse>, Integer, Hash)> refresh_step_content_with_http_info(
|
|
626
|
+
> <Array(<RefreshStepContentResponse>, Integer, Hash)> refresh_step_content_with_http_info(session_id, opts)
|
|
627
627
|
|
|
628
628
|
```ruby
|
|
629
629
|
begin
|
|
630
630
|
# Refresh Step Content
|
|
631
|
-
data, status_code, headers = api_instance.refresh_step_content_with_http_info(
|
|
631
|
+
data, status_code, headers = api_instance.refresh_step_content_with_http_info(session_id, opts)
|
|
632
632
|
p status_code # => 2xx
|
|
633
633
|
p headers # => { ... }
|
|
634
634
|
p data # => <RefreshStepContentResponse>
|
|
@@ -641,7 +641,7 @@ end
|
|
|
641
641
|
|
|
642
642
|
| Name | Type | Description | Notes |
|
|
643
643
|
| ---- | ---- | ----------- | ----- |
|
|
644
|
-
| **
|
|
644
|
+
| **session_id** | **String** | | |
|
|
645
645
|
| **refresh_step_content_request** | [**RefreshStepContentRequest**](RefreshStepContentRequest.md) | | [optional] |
|
|
646
646
|
|
|
647
647
|
### Return type
|
|
@@ -660,7 +660,7 @@ end
|
|
|
660
660
|
|
|
661
661
|
## submit_native_challenge_response
|
|
662
662
|
|
|
663
|
-
> <SubmitNativeChallengeResponseResponse> submit_native_challenge_response(
|
|
663
|
+
> <SubmitNativeChallengeResponseResponse> submit_native_challenge_response(session_id, opts)
|
|
664
664
|
|
|
665
665
|
Submit Native Challenge Response
|
|
666
666
|
|
|
@@ -678,14 +678,14 @@ TrinsicApi.configure do |config|
|
|
|
678
678
|
end
|
|
679
679
|
|
|
680
680
|
api_instance = TrinsicApi::SessionsApi.new
|
|
681
|
-
|
|
681
|
+
session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
682
682
|
opts = {
|
|
683
683
|
submit_native_challenge_response_request: TrinsicApi::SubmitNativeChallengeResponseRequest.new({results_access_key: 'results_access_key_example', response_token: 'response_token_example'}) # SubmitNativeChallengeResponseRequest |
|
|
684
684
|
}
|
|
685
685
|
|
|
686
686
|
begin
|
|
687
687
|
# Submit Native Challenge Response
|
|
688
|
-
result = api_instance.submit_native_challenge_response(
|
|
688
|
+
result = api_instance.submit_native_challenge_response(session_id, opts)
|
|
689
689
|
p result
|
|
690
690
|
rescue TrinsicApi::ApiError => e
|
|
691
691
|
puts "Error when calling SessionsApi->submit_native_challenge_response: #{e}"
|
|
@@ -696,12 +696,12 @@ end
|
|
|
696
696
|
|
|
697
697
|
This returns an Array which contains the response data, status code and headers.
|
|
698
698
|
|
|
699
|
-
> <Array(<SubmitNativeChallengeResponseResponse>, Integer, Hash)> submit_native_challenge_response_with_http_info(
|
|
699
|
+
> <Array(<SubmitNativeChallengeResponseResponse>, Integer, Hash)> submit_native_challenge_response_with_http_info(session_id, opts)
|
|
700
700
|
|
|
701
701
|
```ruby
|
|
702
702
|
begin
|
|
703
703
|
# Submit Native Challenge Response
|
|
704
|
-
data, status_code, headers = api_instance.submit_native_challenge_response_with_http_info(
|
|
704
|
+
data, status_code, headers = api_instance.submit_native_challenge_response_with_http_info(session_id, opts)
|
|
705
705
|
p status_code # => 2xx
|
|
706
706
|
p headers # => { ... }
|
|
707
707
|
p data # => <SubmitNativeChallengeResponseResponse>
|
|
@@ -714,7 +714,7 @@ end
|
|
|
714
714
|
|
|
715
715
|
| Name | Type | Description | Notes |
|
|
716
716
|
| ---- | ---- | ----------- | ----- |
|
|
717
|
-
| **
|
|
717
|
+
| **session_id** | **String** | | |
|
|
718
718
|
| **submit_native_challenge_response_request** | [**SubmitNativeChallengeResponseRequest**](SubmitNativeChallengeResponseRequest.md) | | [optional] |
|
|
719
719
|
|
|
720
720
|
### Return type
|