@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/SessionsApi.md

@@ -0,0 +1,869 @@
+# SessionsApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelSession**](SessionsApi.md#cancelsession) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel Session |
+| [**createDirectProviderSession**](SessionsApi.md#createdirectprovidersessionoperation) | **POST** /api/v1/sessions/provider/direct | Create Direct Provider Session |
+| [**createHostedProviderSession**](SessionsApi.md#createhostedprovidersessionoperation) | **POST** /api/v1/sessions/provider/hosted | Create Hosted Provider Session |
+| [**getAttachment**](SessionsApi.md#getattachmentoperation) | **POST** /api/v1/sessions/{sessionId}/attachments/{attachmentId}/get | Get Attachment |
+| [**getSession**](SessionsApi.md#getsession) | **GET** /api/v1/sessions/{sessionId} | Get Session |
+| [**getSessionResult**](SessionsApi.md#getsessionresultoperation) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
+| [**listSessions**](SessionsApi.md#listsessions) | **GET** /api/v1/verification-profiles/{verificationProfileId}/sessions | List Sessions |
+| [**recommendProviders**](SessionsApi.md#recommendprovidersoperation) | **POST** /api/v1/sessions/providers/recommend | Recommend Providers |
+| [**redactSession**](SessionsApi.md#redactsession) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
+| [**refreshStepContent**](SessionsApi.md#refreshstepcontentoperation) | **POST** /api/v1/sessions/{sessionId}/step/refresh | Refresh Step Content |
+| [**submitNativeChallengeResponse**](SessionsApi.md#submitnativechallengeresponseoperation) | **POST** /api/v1/sessions/{sessionId}/native-challenge/submit | Submit Native Challenge Response |
+
+
+
+## cancelSession
+
+> CancelSessionResponse cancelSession(sessionId)
+
+Cancel Session
+
+Cancel a Session by its ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { CancelSessionRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies CancelSessionRequest;
+
+  try {
+    const data = await api.cancelSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CancelSessionResponse**](CancelSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createDirectProviderSession
+
+> CreateDirectProviderSessionResponse createDirectProviderSession(createDirectProviderSessionRequest)
+
+Create Direct Provider Session
+
+Verify a user\'s identity with a specific provider, handling additional user interaction in your own UI.   Signal which kinds of user interactions your UI can handle using the `Capabilities` field.   If `FallbackToHostedUi` is `true`, Trinsic\'s hosted UI will automatically be invoked to handle any capabilities you do not support.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { CreateDirectProviderSessionOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // CreateDirectProviderSessionRequest (optional)
+    createDirectProviderSessionRequest: ...,
+  } satisfies CreateDirectProviderSessionOperationRequest;
+
+  try {
+    const data = await api.createDirectProviderSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createDirectProviderSessionRequest** | [CreateDirectProviderSessionRequest](CreateDirectProviderSessionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**CreateDirectProviderSessionResponse**](CreateDirectProviderSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createHostedProviderSession
+
+> CreateHostedProviderSessionResponse createHostedProviderSession(createHostedProviderSessionRequest)
+
+Create Hosted Provider Session
+
+Verify a user\'s identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { CreateHostedProviderSessionOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // CreateHostedProviderSessionRequest (optional)
+    createHostedProviderSessionRequest: ...,
+  } satisfies CreateHostedProviderSessionOperationRequest;
+
+  try {
+    const data = await api.createHostedProviderSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createHostedProviderSessionRequest** | [CreateHostedProviderSessionRequest](CreateHostedProviderSessionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**CreateHostedProviderSessionResponse**](CreateHostedProviderSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAttachment
+
+> GetAttachmentResponse getAttachment(sessionId, attachmentId, getAttachmentRequest)
+
+Get Attachment
+
+Fetch an Attachment\'s contents.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { GetAttachmentOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string | The ID of the Session to fetch the Attachment from
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | The ID of the Attachment to fetch
+    attachmentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // GetAttachmentRequest (optional)
+    getAttachmentRequest: ...,
+  } satisfies GetAttachmentOperationRequest;
+
+  try {
+    const data = await api.getAttachment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` | The ID of the Session to fetch the Attachment from | [Defaults to `undefined`] |
+| **attachmentId** | `string` | The ID of the Attachment to fetch | [Defaults to `undefined`] |
+| **getAttachmentRequest** | [GetAttachmentRequest](GetAttachmentRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GetAttachmentResponse**](GetAttachmentResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSession
+
+> GetSessionResponse getSession(sessionId)
+
+Get Session
+
+Get a Session by its ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { GetSessionRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetSessionRequest;
+
+  try {
+    const data = await api.getSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetSessionResponse**](GetSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSessionResult
+
+> GetSessionResultResponse getSessionResult(sessionId, getSessionResultRequest)
+
+Get Session Results
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { GetSessionResultOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // GetSessionResultRequest (optional)
+    getSessionResultRequest: ...,
+  } satisfies GetSessionResultOperationRequest;
+
+  try {
+    const data = await api.getSessionResult(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **getSessionResultRequest** | [GetSessionResultRequest](GetSessionResultRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GetSessionResultResponse**](GetSessionResultResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listSessions
+
+> ListSessionsResponse listSessions(verificationProfileId, orderBy, orderDirection, pageSize, page)
+
+List Sessions
+
+List Sessions created for a specific Verification Profile
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { ListSessionsRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    verificationProfileId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SessionOrdering | The field by which sessions should be ordered (optional)
+    orderBy: Created,
+    // OrderDirection (optional)
+    orderDirection: Descending,
+    // number | The number of items to return per page -- must be between `1` and `50` (optional)
+    pageSize: 50,
+    // number | The page number to return -- starts at `1` (optional)
+    page: 1,
+  } satisfies ListSessionsRequest;
+
+  try {
+    const data = await api.listSessions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **verificationProfileId** | `string` |  | [Defaults to `undefined`] |
+| **orderBy** | `SessionOrdering` | The field by which sessions should be ordered | [Optional] [Defaults to `undefined`] [Enum: Created, Updated, State] |
+| **orderDirection** | `OrderDirection` |  | [Optional] [Defaults to `undefined`] [Enum: Ascending, Descending] |
+| **pageSize** | `number` | The number of items to return per page -- must be between `1` and `50` | [Optional] [Defaults to `undefined`] |
+| **page** | `number` | The page number to return -- starts at `1` | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListSessionsResponse**](ListSessionsResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## recommendProviders
+
+> RecommendProvidersResponse recommendProviders(recommendProvidersRequest)
+
+Recommend Providers
+
+Recommend providers for a specific user session. You can filter based on health (default=online) and specify country and subdivision information. Trinsic will use the phone number and IP address, if provided, to deduce the country and subdivision of the user and use that info for filtering the providers.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { RecommendProvidersOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // RecommendProvidersRequest (optional)
+    recommendProvidersRequest: ...,
+  } satisfies RecommendProvidersOperationRequest;
+
+  try {
+    const data = await api.recommendProviders(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **recommendProvidersRequest** | [RecommendProvidersRequest](RecommendProvidersRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RecommendProvidersResponse**](RecommendProvidersResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## redactSession
+
+> redactSession(sessionId)
+
+Redact Session
+
+Redact a Session, removing all identity data from Trinsic\'s servers. Every verification profile has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { RedactSessionRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies RedactSessionRequest;
+
+  try {
+    const data = await api.redactSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## refreshStepContent
+
+> RefreshStepContentResponse refreshStepContent(sessionId, refreshStepContentRequest)
+
+Refresh Step Content
+
+Refreshes the content of a Step for a Direct Provider Session.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { RefreshStepContentOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // RefreshStepContentRequest (optional)
+    refreshStepContentRequest: ...,
+  } satisfies RefreshStepContentOperationRequest;
+
+  try {
+    const data = await api.refreshStepContent(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **refreshStepContentRequest** | [RefreshStepContentRequest](RefreshStepContentRequest.md) |  | [Optional] |
+
+### Return type
+
+[**RefreshStepContentResponse**](RefreshStepContentResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## submitNativeChallengeResponse
+
+> SubmitNativeChallengeResponseResponse submitNativeChallengeResponse(sessionId, submitNativeChallengeResponseRequest)
+
+Submit Native Challenge Response
+
+Submits the response from a Native Challenge (e.g., mDL exchange via DC API) and processes the results.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SessionsApi,
+} from '@trinsic/api';
+import type { SubmitNativeChallengeResponseOperationRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SessionsApi(config);
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SubmitNativeChallengeResponseRequest (optional)
+    submitNativeChallengeResponseRequest: ...,
+  } satisfies SubmitNativeChallengeResponseOperationRequest;
+
+  try {
+    const data = await api.submitNativeChallengeResponse(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **submitNativeChallengeResponseRequest** | [SubmitNativeChallengeResponseRequest](SubmitNativeChallengeResponseRequest.md) |  | [Optional] |
+
+### Return type
+
+[**SubmitNativeChallengeResponseResponse**](SubmitNativeChallengeResponseResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+