### Install @trinsic/web-ui with npm

Source: https://docs.trinsic.id/reference/ui-web

Install the package using npm.

```sh
npm install @trinsic/web-ui
```

--------------------------------

### Install @trinsic/expo-ui

Source: https://docs.trinsic.id/reference/ui-expo

Install the Expo UI library package using npm.

```sh
npm install @trinsic/expo-ui
```

--------------------------------

### info Parameter Example

Source: https://docs.trinsic.id/docs/zero-access-hpke

Example of the `info` parameter for a session-results domain with a specific context UUID. The version is always 1, and the context is a domain-specific structure.

```csharp
trinsic-hpke:1:session-results:6725f68a-5501-80c2-9c85-c5f36fbc602a
```

--------------------------------

### Example rawMdlOutput.nameSpaces JSON

Source: https://docs.trinsic.id/docs/usa-california-dmv

Shows the structure of the rawMdlOutput.nameSpaces field with sample data for a US mDL, including family_name, given_name, birth_date, and age_over_21.

```json
{
    "org.iso.18013.5.1": {
        "family_name": {
            "type": "String",
            "value": "DOE"
        },
        "given_name": {
            "type": "String",
            "value": "JOHN"
        },
        "birth_date": {
            "type": "String",
            "value": "2000-03-27"
        },
        "age_over_21": {
            "type": "Boolean",
            "value": "true"
        }
    }
}
```

--------------------------------

### Create Session Request with preview_raw18013Request (commented)

Source: https://docs.trinsic.id/docs/samsung-wallet-available-18013-documents

JSON example showing how to specify a custom 18013 request in the providerInput field for Samsung Wallet. Includes comments explaining the structure: documentRequests array, documentType, nameSpaces map with willRetain flags.

```json
{
    "verificationProfileId": "...",
    "provider": "samsung-wallet",

    // Other fields omitted

    "providerInput": {
        "samsung-wallet": {
            "preview_raw18013Request": {
                // `documentRequests` is an array of requests, each describing a single document.
                // A credential which satisfies *any* of the requests can be used by the user.
                // Only a single credential is collected and returned.
                "documentRequests": [
                    {
                        // The document type to request -- see Trinsic's documentation 
                        // for a list of all valid document types for Samsung Wallet
                        "documentType": "org.iso.18013.5.1.mDL",

                        // A map of (nameSpaceName -> map(fieldName -> willRetain)), where:
                        // - nameSpaceName is a namespace within the document
                        // - fieldName is a field within the given namespace
                        // - willRetain indicates whether you intend to store the data beyond the scope of the immediate transaction
                        "nameSpaces": {
                            "org.iso.18013.5.1": {
                                // `given_name` is required, and will be stored by the requester
                                "given_name": true,

                                // `portrait` is required, and will NOT be stored by the requester
                                "portrait": false
                            }
                        }
                    }
                ]
            }
        }
    }
}
```

--------------------------------

### GET /api/valpha/verification-profiles/{id}

Source: https://docs.trinsic.id/reference/getverificationprofilebyid

Gets a specific verification profile by ID. The profile ID is provided as a path parameter.

```APIDOC
## GET /api/valpha/verification-profiles/{id}

### Description
Gets a specific verification profile by ID.

### Method
GET

### Endpoint
/api/valpha/verification-profiles/{id}

### Parameters
#### Path Parameters
- **id** (string, uuid) - Required - The unique identifier of the verification profile.

### Response
#### Success Response (200)
Returns the verification profile details.

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **500** - Internal server error

```

--------------------------------

### GET /sessions

Source: https://docs.trinsic.id/reference/listsessions

Retrieves a list of verification sessions. Supports filtering by state, ordering, and pagination.

```APIDOC
## GET /sessions

### Description
Retrieves a list of verification sessions. Supports filtering by state, ordering, and pagination.

### Method
GET

### Endpoint
/sessions

### Parameters
#### Query Parameters
- **state** (string) - Optional - Filter sessions by state. Possible values: `Created`, `Pending`, `InProgress`, `Completed`, `Failed`, `Canceled`.
- **orderBy** (string) - Optional - Order sessions by a field. Possible values: `Created`, `Updated`, `State`.
- **pageSize** (integer) - Optional - Number of sessions to return per page.
- **pageToken** (string) - Optional - Token for pagination.

### Response
#### Success Response (200)
- **sessions** (array) - List of session objects.
- **nextPageToken** (string) - Token for the next page, if any.

#### Response Example
{
  "sessions": [
    {
      "id": "string",
      "state": "string",
      "errorCode": "string",
      "created": 1722526411,
      "updated": 1722526722
    }
  ],
  "nextPageToken": "string"
}

### Error Handling
- **401 Unauthorized** - Missing or invalid Bearer token.
- **400 Bad Request** - Invalid query parameters.

### Authentication
Requires a Bearer token (Trinsic Connect API Key) in the Authorization header.
```

--------------------------------

### Use custom scheme in redirectUrl

Source: https://docs.trinsic.id/reference/ui-android

Example redirectUrl using the custom scheme. The path (callback) can be any valid path string.

```text
acme-corp-shopping-app-trinsic-redirect:///callback
```

--------------------------------

### Add TrinsicUI pod to Podfile

Source: https://docs.trinsic.id/reference/ui-swift

Add the TrinsicUI pod to your Podfile with the latest version and run pod install.

```ruby
pod 'TrinsicUI', '~> [latest version]'
```

--------------------------------

### GET /api/v1/verification-profiles/{verificationProfileId}/sessions

Source: https://docs.trinsic.id/reference/listsessions

Lists sessions created for a specific Verification Profile. Supports pagination and ordering.

```APIDOC
## GET /api/v1/verification-profiles/{verificationProfileId}/sessions

### Description
List Sessions created for a specific Verification Profile.

### Method
GET

### Endpoint
/api/v1/verification-profiles/{verificationProfileId}/sessions

### Parameters
#### Path Parameters
- **verificationProfileId** (string, uuid) - Required - The unique identifier of the Verification Profile.

#### Query Parameters
- **OrderBy** (SessionOrdering) - Optional - The field by which sessions should be ordered. Possible values: Created, Updated, State.
- **OrderDirection** (OrderDirection) - Optional - The direction of ordering. Possible values: Ascending, Descending.
- **PageSize** (integer, int32) - Optional - The number of items to return per page. Must be between 1 and 50.
- **Page** (integer, int32) - Optional - The page number to return. Starts at 1.

### Response
#### Success Response (200)
Returns a ListSessionsResponse object containing the list of sessions.

#### Error Responses
- **400** - Bad request. Returns a ProblemDetails object.
- **401** - Unauthorized. Returns a ProblemDetails object.
```

--------------------------------

### Activity Result API: Initialize TrinsicUI and Launch Session

Source: https://docs.trinsic.id/reference/ui-android

Use this Java snippet to initialize TrinsicUI unconditionally in onCreate and launch a session. The callback receives the session ID and cancellation status. Call launchSession with the launch URL to start the session.

```java
private TrinsicUI trinsicUi;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // You must ALWAYS instantiate TrinsicUI unconditionally during `onCreate`
    trinsicUi = new TrinsicUI(this, result -> {
        // This callback will be called when a launched Session completes or is canceled by the user
        String sessionId = result.getSessionId();
        boolean canceled = result.getCanceled();
        
        // Call your backend to handle Session results
    });
}

private void launchSession(String launchUrl) {
    trinsicUi.LaunchSession(this, launchUrl);
}
```

--------------------------------

### GET /api/valpha/verification-profiles

Source: https://docs.trinsic.id/reference/listverificationprofiles

Lists the verification profiles for the current organization and environment. Supports pagination via page and pageSize query parameters, and optional filtering by geography.

```APIDOC
## GET /api/valpha/verification-profiles

### Description
List the verification profiles for the current organization and environment.

### Method
GET

### Endpoint
/api/valpha/verification-profiles

### Parameters
#### Query Parameters
- **page** (integer, int32) - Optional - Page number to retrieve. Minimum 1, maximum 2147483647. Default: 1.
- **pageSize** (integer, int32) - Optional - Size of the list to be returned. Accepted range from 1 to 100. Default: 20.
- **geography** (string) - Optional - Filter by data-residency geography. Accepted values: "US", "EU" (case-insensitive). Omit to include all geographies.

### Response
#### Success Response (200)
Returns a ListVerificationProfilesResponse object containing the list of verification profiles and pagination metadata.

#### Error Responses
- **400** - Bad request. Returns a ProblemDetails object.
- **401** - Unauthorized. Returns a ProblemDetails object.
- **403** - Forbidden. Returns a ProblemDetails object.
- **500** - Internal server error. Returns a ProblemDetails object.

```

--------------------------------

### GET /v1/redirect_uris

Source: https://docs.trinsic.id/reference/list

Lists all redirect URIs within the environment. Returns a paginated list of redirect URIs and a flag indicating if more pages are available.

```APIDOC
## GET /v1/redirect_uris

### Description
Lists all redirect URIs within the environment. Returns a paginated list of redirect URIs and a flag indicating if more pages are available.

### Method
GET

### Endpoint
/v1/redirect_uris

### Parameters
#### Query Parameters
- **more** (boolean) - Optional - Indicates if there are more pages to retrieve. If true, the response contains additional pages.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **uris** (array of RedirectUriResponse) - List of redirect URIs within the environment.
- **more** (boolean) - Whether there are additional pages of URIs to retrieve.

#### Response Example
{
  "uris": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "uri": "https://example.com/callback"
    }
  ],
  "more": true
}

### Error Handling
- **401 Unauthorized** - Invalid or missing bearer token.
- **403 Forbidden** - Insufficient permissions.
- **404 Not Found** - Resource not found.
- **500 Internal Server Error** - Unexpected server error.
```

--------------------------------

### GET /api/v1/verificationprofiles

Source: https://docs.trinsic.id/reference/listverificationprofiles

Retrieves a list of verification profiles. The response includes an array of verification profile objects and a boolean indicating whether more pages are available.

```APIDOC
## GET /api/v1/verificationprofiles

### Description
Retrieves a list of verification profiles. The response includes an array of verification profile objects and a boolean indicating whether more pages are available.

### Method
GET

### Endpoint
/api/v1/verificationprofiles

### Parameters
#### Query Parameters
- **more** (boolean) - Optional - Whether there are additional pages of verification profiles to retrieve.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **verificationProfiles** (array of VerificationProfileResponse) - List of verification profiles.
- **more** (boolean) - Whether there are additional pages of verification profiles to retrieve.

#### Response Example
{
  "verificationProfiles": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "string",
      "brandName": "string",
      "externalId": "string",
      "geography": "US",
      "logoUrl": "string",
      "primaryColor": "string",
      "enabledProviders": ["string"],
      "sessionExpiration": "string",
      "isProductionUsage": true
    }
  ],
  "more": true
}

#### Error Response (500)
- **type** (string) - A URI reference that identifies the problem type.
- **title** (string) - A short, human-readable summary of the error.
- **status** (integer) - The HTTP status code returned for the request.
- **detail** (string) - A human-readable explanation specific of the problem.
- **instance** (string) - A URI reference that identifies the specific occurrence of the problem.

#### Error Example
{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
  "title": "Internal Server Error",
  "status": 500,
  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
}

### Authentication
Bearer token required. Use Trinsic Connect API Key.
```

--------------------------------

### List Sessions - OpenAPI definition

Source: https://docs.trinsic.id/reference/listsessions

Complete OpenAPI definition for listing sessions, including parameters like verificationProfileId, OrderBy, OrderDirection, PageSize, and Page, along with response schemas and example error formats.

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Trinsic API",
    "version": "v1",
    "x-swaggerexclude": "External"
  },
  "servers": [
    {
      "url": "https://api.trinsic.id",
      "description": "Production server"
    },
    {
      "url": "https://api.eu.trinsic.id",
      "description": "Production server (EU data residency preview)"
    }
  ],
  "paths": {
    "/api/v1/verification-profiles/{verificationProfileId}/sessions": {
      "get": {
        "tags": [
          "Sessions"
        ],
        "summary": "List Sessions",
        "description": "List Sessions created for a specific Verification Profile",
        "operationId": "ListSessions",
        "parameters": [
          {
            "name": "verificationProfileId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "OrderBy",
            "in": "query",
            "description": "The field by which sessions should be ordered",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/SessionOrdering"
                }
              ],
              "example": "Created",
              "x-enumDescriptions": {
                "Created": "Order sessions by their creation date",
                "Updated": "Order sessions by the date their state last changed",
                "State": "Order sessions by their state"
              }
            },
            "example": "Created"
          },
          {
            "name": "OrderDirection",
            "in": "query",
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/OrderDirection"
                }
              ],
              "example": "Descending",
              "x-enumDescriptions": {
                "Ascending": "",
                "Descending": ""
              }
            },
            "example": "Descending"
          },
          {
            "name": "PageSize",
            "in": "query",
            "description": "The number of items to return per page -- must be between `1` and `50`",
            "schema": {
              "maximum": 50,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "example": 50
            },
            "example": 50
          },
          {
            "name": "Page",
            "in": "query",
            "description": "The page number to return -- starts at `1`",
            "schema": {
              "maximum": 2147483647,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "example": 1
            },
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ListSessionsResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListSessionsResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListSessionsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
                  "title": "Bad Request",
                  "detail": "This feature is not supported for your configuration",
                  "status": 400,
                  "traceId": "00-3fcbc632c5caaca825849d495c62d7b0-09a3500f89acbbcc-00",
                  "instance": "/api/v1/sample-request-path",
                  "errors": {
                    "PropertyName": [
                      "Specific error description for property"
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Register custom scheme redirect URL with Trinsic

Source: https://docs.trinsic.id/reference/ui-android

Example redirect URL to register with Trinsic on the Dashboard. The wildcard (*) allows any path, and the triple slash is required for a valid custom scheme URL.

```text
acme-corp-shopping-app-trinsic-redirect:///*
```

--------------------------------

### Load @trinsic/web-ui via CDN (unpkg)

Source: https://docs.trinsic.id/reference/ui-web

Include the library via a script tag from unpkg.

```html
<script src="http://unpkg.com/@trinsic/web-ui"><script>
```

--------------------------------

### OpenAPI definition for Get Provider endpoint

Source: https://docs.trinsic.id/reference/getprovider

OpenAPI definition for the Get Provider endpoint. It specifies the GET /api/v1/providers/{providerId} operation with a required providerId path parameter, and documents possible responses including 200 OK, 400 Bad Request, 401 Unauthorized, 403 Forbidden, and 500 Internal Server Error. The schema includes the AttributeAvailability enum with values Never, Sometimes, and Always.

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Trinsic API",
    "version": "v1",
    "x-swaggerexclude": "External"
  },
  "servers": [
    {
      "url": "https://api.trinsic.id",
      "description": "Production server"
    },
    {
      "url": "https://api.eu.trinsic.id",
      "description": "Production server (EU data residency preview)"
    }
  ],
  "paths": {
    "/api/v1/providers/{providerId}": {
      "get": {
        "tags": [
          "Providers"
        ],
        "summary": "Get Provider",
        "description": "Get a single identity provider by ID, including its license status.",
        "operationId": "GetProvider",
        "parameters": [
          {
            "name": "providerId",
            "in": "path",
            "description": "The ID of the provider to retrieve",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/GetProviderResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetProviderResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetProviderResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
                  "title": "Bad Request",
                  "detail": "This feature is not supported for your configuration",
                  "status": 400,
                  "traceId": "00-3fcbc632c5caaca825849d495c62d7b0-09a3500f89acbbcc-00",
                  "instance": "/api/v1/sample-request-path",
                  "errors": {
                    "PropertyName": [
                      "Specific error description for property"
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
                  "title": "Unauthorized",
                  "status": 401,
                  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
                  "title": "Forbidden",
                  "status": 403,
                  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "example": {
                  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
                  "title": "Internal Server Error",
                  "status": 500,
                  "traceId": "00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AttributeAvailability": {
        "enum": [
          "Never",
          "Sometimes",
          "Always"
        ],
        "type": "string",
        "description": "Indicates when an attribute will be available in verification results.",
        "x-enumDescriptions": {
          "Never": "This attribute will never be present in verification results.",
        }
      }
    }
  }
}
```

--------------------------------

### Migrate from launchPopup to createPopupAndWaitForResults

Source: https://docs.trinsic.id/changelog/october-2025

Shows the new createPopupAndWaitForResults() API and the previous launchPopup() implementation for comparison. The new API requires a sessionCreationFunction callback that returns a launch URL, and resolves with a sessionId after the popup signals completion.

```JavaScript
import { createPopupAndWaitForResults } from "@trinsic/web-ui";

// Create a popup, initialize it with a launch URL, and wait for it to signal completion
const result = await createPopupAndWaitForResults({
  // A callback function which should call your backend to create a Trinsic Session,
  // and return the Launch URL.
  //
  // This pattern is necessary due to browser restrictions around opening a popup too late
  // after a user gesture (e.g. button click).
  sessionCreationFunction: async () => {
    // Hit your backend to create a Trinsic Session and return its launch URL
    return await createTrinsicSessionLaunchUrl();
  },
});

// Notify your backend of Session completion
const sessionId = result.sessionId;
await notifyBackend(sessionId);
```

```JavaScript
// Previous implementation
import { launchPopup } from "@trinsic/web-ui";

// Call `launchPopup()`, passing a callback to asynchronously create a Session URL
// `launchPopup()` resolves when it receives a completion signal from the popup, or on error
const result = await launchPopup(async () => {
  // Hit backend to create a Trinsic Session and return its launch URL
	return await createTrinsicSessionLaunchUrl();
});

// Notify your backend of Session completion
const sessionId = result.sessionId;
await notifyBackend(sessionId);
```

--------------------------------

### GET /api/v1/providers

Source: https://docs.trinsic.id/reference/listproviders

Lists all identity providers available to the organization, with an optional filter by license status.

```APIDOC
## GET /api/v1/providers

### Description
List all identity providers available to your Organization, including their license status.

### Method
GET

### Endpoint
/api/v1/providers

### Parameters
#### Query Parameters
- **licensed** (boolean) - Optional - Filter by license status. If not specified, returns all providers.

### Response
#### Success Response (200)
Returns a ListProvidersResponse object.

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **500** - Internal server error
```

--------------------------------

### GET /api/v1/sessions/{sessionId}

Source: https://docs.trinsic.id/reference/getsession

Retrieves a Session by its unique identifier. The response contains the Session object.

```APIDOC
## GET /api/v1/sessions/{sessionId}

### Description
Get a Session by its ID.

### Method
GET

### Endpoint
/api/v1/sessions/{sessionId}

### Parameters
#### Path Parameters
- **sessionId** (string, uuid) - Required - The unique identifier of the session.

### Response
#### Success Response (200)
- **session** (object) - The Session object.

#### Response Example
{
  "session": {}
}

#### Error Responses
- **400** - Bad request. Returns a ProblemDetails object.
- **401** - Unauthorized. Returns a ProblemDetails object.
- **403** - Forbidden. Returns a ProblemDetails object.
- **500** - Internal server error. Returns a ProblemDetails object.

```

--------------------------------

### Initialize popup and await results

Source: https://docs.trinsic.id/reference/ui-web

Initializes the popup with a launch URL and awaits completion. The `onWindowMaybeClosed` callback handles connection loss, and `pollingFunction` is required when running in an iFrame. The result contains `sessionId` and `code`.

```javascript
// Initialize popup with Launch URL for Session
popup.initialize(launchUrl);

// Await results
const popupResult = await popup.waitForCompletion({
  onWindowMaybeClosed: () => {
    // OPTIONAL
    //
    // This function is called when the connection to the popup window is lost.
    // This can occur if the popup is closed, but can also occur if the popup
    // visits a page with a restrictive `Cross-Origin-Opener-Policy` header,
    // thus causing the browser to sever the connection to the popup for security reasons.

    // Because the popup may still be open and may still resolve successfully, you should not
    // take an authoritative action here. Instead, use this callback to prompt your UI
    // to display a prompt to the user, where they are given the opportunity to cancel out or retry.
  },

  pollingFunction: async () => {
    // OPTIONAL unless running in an iFrame
    //
    // A function which will periodically be called to check if the session is complete.
    // If this function returns `true`, the `waitForCompletion()` call will resolve.
    //
    // This MUST be specified if you are launching a popup from within an iFrame.
  }
});

// `code` contains a response code indicating the reason the `waitForCompletion()` call resolved.
const {sessionId, code} = popupResult.code;

// To know if the Session was successful or unsuccessful, call your backend to hit Trinsic's API.
```

--------------------------------

### Launch a verification session

Source: https://docs.trinsic.id/reference/ui-expo

Call launchSession with a launch URL from a trusted backend and a callback path. The result is logged to the console.

```tsx
const result: LaunchSessionResult = await launchSession(launchUrl, {
  callbackPath: "/",
});
console.log(result);
```

--------------------------------

### Configure Web UI SDK popup with custom domain

Source: https://docs.trinsic.id/docs/custom-domain

Use this TypeScript snippet to set the initial loading page and window title when launching a verification popup with the Web UI SDK. This is needed because the SDK opens a popup to a Trinsic-hosted loading page before redirecting to the Session's launch URL. The initialUrl and initialWindowTitle parameters override that behavior.

```typescript
const popup = trinsicUi.createPopup({
  initialUrl: `https://${window.location.hostname}/loading`,
  initialWindowTitle: "Your Company Verification",
});
```

--------------------------------

### GET /v1/verificationprofiles/external/{externalId}

Source: https://docs.trinsic.id/reference/getverificationprofilebyexternalid

Retrieves a verification profile by its external ID. The external ID is customer-defined and unique within the organization.

```APIDOC
## GET /v1/verificationprofiles/external/{externalId}

### Description
Retrieves a verification profile by its customer-defined external ID. The external ID is unique within your organization.

### Method
GET

### Endpoint
/v1/verificationprofiles/external/{externalId}

### Parameters
#### Path Parameters
- **externalId** (string) - Required - The customer-defined external ID of the verification profile.

### Response
#### Success Response (200)
- **id** (string, uuid) - The ID of the verification profile.
- **alias** (string) - An alias of the verification profile shown to developers and administrators.
- **brandName** (string) - The brand name of the verification profile shown to end-users.
- **externalId** (string, nullable) - A customer-defined external ID for this verification profile, unique within your organization.
- **geography** (string) - The data-residency geography of the verification profile, such as "US" or "EU".
- **logoUrl** (string) - The URL of the verification profile's logo.
- **primaryColor** (string) - The primary color of the verification profile.
- **enabledProviders** (array of string) - The providers that are currently enabled for the verification profile.
- **sessionExpiration** (string, date-span) - The session expiration for verification sessions created with this profile.
- **isProductionUsage** (boolean) - Whether this profile is for production usage. Only applicable for Live environment profiles.

#### Response Example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "alias": "string",
  "brandName": "string",
  "externalId": "string",
  "geography": "US",
  "logoUrl": "string",
  "primaryColor": "string",
  "enabledProviders": ["string"],
  "sessionExpiration": "string",
  "isProductionUsage": true
}

#### Error Response (404)
- **type** (string) - A URI reference that identifies the problem type.
- **title** (string, nullable) - A short, human-readable summary of the error.
- **status** (integer, nullable) - The HTTP status code returned for the request.
- **detail** (string, nullable) - A human-readable explanation specific to the problem.
- **instance** (string, nullable) - A URI reference that identifies the specific occurrence of the problem.

#### Error Example
{
  "type": "string",
  "title": "string",
  "status": 404,
  "detail": "string",
  "instance": "string"
}

### Authentication
- **Bearer** (http, bearer) - Trinsic Connect API Key. All requests require a valid bearer token.
```

--------------------------------

### Launch a session with TrinsicUI

Source: https://docs.trinsic.id/reference/ui-swift

Create an instance of TrinsicUI and launch a session using a launch URL from a trusted backend and a callback URL scheme.

```swift
let trinsicUI = TrinsicUI()
let result = try await trinsicUI.launchSession(launchUrl: "[REPLACE_ME]", callbackUrlScheme: "[REPLACE_ME]")
```

--------------------------------

### Configure iOS Podfile for static libraries

Source: https://docs.trinsic.id/reference/ui-flutter

Add this line to your Podfile to use static libraries, required for the Swift module.

```ruby
use_frameworks! :linkage => :static
```

--------------------------------

### Create popup with createPopup

Source: https://docs.trinsic.id/reference/ui-web

Creates a popup instance using `createPopup` from `@trinsic/web-ui`. Throws if the popup fails to open, such as when blocked by the browser. The `initialWindowTitle` is set to "Test".

```javascript
import { createPopup, TrinsicPopup } from "@trinsic/web-ui";

let popup: TrinsicPopup;
try {
  popup = createPopup({
    initialWindowTitle: "Test",
  });
} catch (e) {
  console.error("Failed to create popup", e);
  return;
}
```

--------------------------------

### GET /api/valpha/redirect-uris

Source: https://docs.trinsic.id/reference/list

List registered Redirect URIs for the authenticated environment. Supports pagination via page and pageSize query parameters.

```APIDOC
## GET /api/valpha/redirect-uris

### Description
List registered Redirect URIs for the authenticated environment.

### Method
GET

### Endpoint
/api/valpha/redirect-uris

### Parameters
#### Query Parameters
- **page** (integer, int32) - Optional - Number of pages of uris to return. Minimum: 1, Maximum: 2147483647, Default: 1
- **pageSize** (integer, int32) - Optional - Size of the list to be returned. Accepted range from 1 to 100. Minimum: 1, Maximum: 100, Default: 20

### Response
#### Success Response (200)
- **ListRedirectUrisResponse** - The response body contains a list of redirect URIs. The exact schema is referenced as `#/components/schemas/ListRedirectUrisResponse`.

#### Response Example
```json
{
  "redirectUris": [
    "https://example.com/callback"
  ]
}
```

#### Error Responses
- **400 Bad Request** - The request was invalid. See the response body for details.
- **401 Unauthorized** - Authentication failed or missing credentials.
- **403 Forbidden** - The authenticated user does not have permission to access this resource.
- **500 Internal Server Error** - An unexpected error occurred on the server.
```

--------------------------------

### Import createPopup from @trinsic/web-ui

Source: https://docs.trinsic.id/reference/ui-web

Import the createPopup function when using a module bundler.

```js
import { createPopup } from "@trinsic/web-ui";
```

--------------------------------

### Create popup with EU data residency initial URL

Source: https://docs.trinsic.id/reference/ui-web

Sets the initial loading URL to the EU endpoint for popup flows when using a Verification Profile configured for EU data residency. Omit the initialUrl to use the default endpoint.

```javascript
const popup = createPopup({
  initialUrl: "https://verify.eu.trinsic.id/loading", // omit to use the default endpoint
});
```

--------------------------------

### POST /api/v1/sessions/recommendproviders

Source: https://docs.trinsic.id/reference/recommendproviders

Generates a list of recommended Identity Providers based on user information such as phone number, country, and IP address. The response includes a prioritized list of providers and a remainder list of all other providers available to the verification profile.

```APIDOC
## POST /api/v1/sessions/recommendproviders

### Description
Generates a list of recommended Identity Providers based on user information such as phone number, country, and IP address. The response includes a prioritized list of providers and a remainder list of all other providers available to the verification profile.

### Method
POST

### Endpoint
/api/v1/sessions/recommendproviders

### Parameters
#### Request Body
- **recommendationInfo** (RecommendationInfo) - Optional - Information about the user you wish to generate a recommendation for.
- **health** (RecommendProviderHealthOption) - Optional - Filter providers by health status. Possible values: Online, Offline, All.

### Request Example
{
  "recommendationInfo": {
    "phoneNumber": "+15551234567",
    "countries": ["US"],
    "subdivisions": ["CA"],
    "ipAddresses": ["192.168.1.1"]
  },
  "health": "Online"
}

### Response
#### Success Response (200)
- **recommendedProviders** (array of RecommendProviderInformation) - The list of recommended providers.
- **remainder** (array of RecommendProviderInformation) - All Providers available to your Verification Profile which are not in `recommendedProviders`.

#### Response Example
{
  "recommendedProviders": [
    {
      "id": "provider-id",
      "name": "Provider Name",
      "logoUrl": "https://example.com/logo.png",
      "darkModeLogoUrl": "https://example.com/logo-dark.png",
      "subtext": "dmv.ca.gov"
    }
  ],
  "remainder": [
    {
      "id": "provider-id-2",
      "name": "Provider Name 2",
      "logoUrl": "https://example.com/logo2.png",
      "darkModeLogoUrl": null,
      "subtext": "example.gov"
    }
  ]
}

### Security
- **Bearer** (http) - Trinsic Connect API Key
```

--------------------------------

### POST /v1/sessions/hosted-provider

Source: https://docs.trinsic.id/reference/createhostedprovidersession

Creates a new hosted provider session. The request must include the provider ID, verification profile ID, and redirect URL. Optional fields include browser language preferences and provider-specific input.

```APIDOC
## POST /v1/sessions/hosted-provider

### Description
Creates a new hosted provider session for identity verification. The user is redirected to the specified provider, and after completion, returned to the redirect URL.

### Method
POST

### Endpoint
/v1/sessions/hosted-provider

### Parameters
#### Request Body
- **provider** (string) - Required - The ID of the provider to launch.
- **verificationProfileId** (string, uuid) - Required - The ID of the Verification Profile to use for this session.
- **redirectUrl** (string) - Required - The Redirect URL to which the user should be sent after the session is complete.
- **browserLanguages** (array of string) - Optional - Preferences for languages to show first in the Hosted UI and supported provider launch flows. If left empty, defaults to user's navigator languages; falls back to English.
- **providerInput** (object) - Optional - Provider-specific input data, referencing the ProviderInput schema.

### Request Example
{
  "provider": "string",
  "verificationProfileId": "uuid",
  "redirectUrl": "string",
  "browserLanguages": ["string"],
  "providerInput": {}
}

### Response
#### Success Response (200)
- **sessionId** (string) - The ID of the created session.
- **launchUrl** (string) - The URL to launch the hosted provider session.

#### Response Example
{
  "sessionId": "string",
  "launchUrl": "string"
}
```

--------------------------------

### GET /api/valpha/verification-profiles/external-ids/{externalId}

Source: https://docs.trinsic.id/reference/getverificationprofilebyexternalid

Retrieves a specific verification profile by its customer-defined external ID. This endpoint is part of the Trinsic API and requires the external ID as a path parameter.

```APIDOC
## GET /api/valpha/verification-profiles/external-ids/{externalId}

### Description
Gets a specific verification profile by its customer-defined external ID.

### Method
GET

### Endpoint
/api/valpha/verification-profiles/external-ids/{externalId}

### Parameters
#### Path Parameters
- **externalId** (string) - Required - Customer-defined external ID

### Response
#### Success Response (200)
Returns a VerificationProfileResponse object.

#### Response Example
```json
{
  "type": "object",
  "properties": {}
}
```

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **500** - Internal server error

```

--------------------------------

### POST /api/v1/sessions/provider/hosted

Source: https://docs.trinsic.id/reference/createhostedprovidersession

Creates a hosted provider session for identity verification. Requires a verification profile ID and returns a session response.

```APIDOC
## POST /api/v1/sessions/provider/hosted

### Description
Verify a user's identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.

### Method
POST

### Endpoint
/api/v1/sessions/provider/hosted

### Parameters
#### Request Body
- **verificationProfileId** (string) - Required - The verification profile ID to use for the session.

### Request Example
{
  "verificationProfileId": "string"
}

### Response
#### Success Response (200)
- **CreateHostedProviderSessionResponse** (object) - The response containing the hosted provider session details.

#### Response Example
{
  "sessionId": "string",
  "url": "string"
}

#### Error Responses
- **400 Bad Request** - The request is invalid or the feature is not supported for your configuration.
- **401 Unauthorized** - Authentication is required or failed.
- **403 Forbidden** - The authenticated user does not have permission to perform this action.
```

--------------------------------

### TrinsicHPKEBundle without comments

Source: https://docs.trinsic.id/docs/zero-access-hpke

Clean version of the TrinsicHPKEBundle JSON without comments, for direct use in code. Contains the same fields as the commented example but omits the 'recipientPublicKeyJwkThumbprint' field.

```json
{
    "trinsicHpkeVersion": 1,
    "metadata": {
        "mode": 0,
        "kem": 16,
        "kdf": 1,
        "aead": 1,
        "infoHash": "K5iric4zDBxK2mND77jy5Iu9N1K0K+1YXrYMtXbQvJQ=",
        "recipientPublicKeyHash": "mmTQVVYT13zL9eA4HoijLh+FwUzgRC7tV5CaHji+hcI="
    },
    "ephemeralSenderPublicKey": "BMV9NqGWIe00D0Z8z88uN72JC1hR6DaBciSsVDmjGiOLCQLrjRptF1wGrMRpLlmc4m02R4CssDS586eRLItU2yA=",
    "ciphertext": "6/KCzUhwWaAoAioz0z6AU/HbZX8="
}
```

--------------------------------

### Create Direct Provider Session - Request and Response Payloads

Source: https://docs.trinsic.id/docs/direct-provider-session

Sample request and response payloads for the Create Direct Provider Session method. The request includes capabilities, provider, redirectUrl, and fallbackToHostedUI. The response contains sessionId, resultCollection with resultsAccessKey, and nextStep with a deeplink content.

```json
{
	"verificationProfileId": "47d3b6cf-e93b-4ecd-a8c0-65013dc9f935",
  "capabilities": [
    "LaunchBrowser",
    "DeeplinkToMobile",
    "CaptureRedirect",
    "PollResult"
  ],
  "provider": "ca-mdl",
  "redirectUrl": "https://example.com/redirects/trinsic",
  "fallbackToHostedUI": true
}
```

```json
{
  "sessionId": "67cb115f-ec42-48c1-9508-c0695996b971",
  "resultCollection": {
    "method": "PollResult",
    "resultsAccessKey": "38Kv8vrC3rm6vrb2RfhzDtrDnpFs8kfbKXXEiZ6oumyDt6muTfCtRfksGjdpcuYTkPRju87iqjsPpkyVGAWaf2yYEfGJa7f8W55RzBFkhr7wbVGqD4F9AmgLsPmuUaefptgAEHAJEjAB5Kbzr5dZ36UZQEYnLwgJrEzxYo52FUbw7h6UBV73Rma6HHySE7g9AF29rcNbRYg9YYac8ofoDR5jeTfFWbSoFdTk3hJZRJTSYfD2Ru9EpUtaCWBewHjSc1GY3otAU3DwAnRDgyuasM7uL4NQQff2bwAEA9V39Fh6xvFco28"
  },
  "nextStep": {
    "method": "DeeplinkToMobile",
    "content": "openid4vp://?client_id=did%3Aweb%3Aca-mdl.trinsic.id&request_uri=https%3A%2F%2Fca-mdl.trinsic.id%2Fworkflows%2Fz1Ca28JZPqBeAEcED50avWw2L%2Fexchanges%2Fz19mWDsEC93jhADwekJNLYK7V%2Fopenid%2Fclient%2Fauthorization%2Frequest"
  }
}
```

--------------------------------

### Import launchSession and LaunchSessionResult

Source: https://docs.trinsic.id/reference/ui-expo

Import the launchSession method and the LaunchSessionResult type from the @trinsic/expo-ui package.

```tsx
import { launchSession, LaunchSessionResult } from '@trinsic/expo-ui
```