Our StoryBlogPodcastAdoption Report
Reference
Activate Account

Create Direct Provider Session

post
https://api.trinsic.id/api/v1/sessions/provider/direct

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

The ID of the provider to launch

uuid
required

The ID of the Verification Profile to use for this session.

string | null

The Redirect URL to which the user should be sent after the session is complete.

This field is required for providers which employ a redirect-based flow.

capabilities
array of objects
required
length ≥ 1

The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.

Most capabilities align with either an IntegrationLaunchMethod or an IntegrationCollectionMethod. The exception being refresh content to support updating the content of the launch method.

For example, to support a basic redirect-based flow, you must include the LaunchRedirect and CaptureRedirect capabilities. To support a mobile deeplink / polling flow, you must include the DeeplinkToMobile and PollForResults capabilities.

If FallbackToHostedUi is true, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If FallbackToHostedUi is false, gaps in your integration's capabilities will result in an error during Session creation.

Read more on how to integrate at the guide on Direct Provider Sessions

capabilities*
boolean | null

Whether the session should fall back to a Trinsic-hosted UI in certain instances.

Specifically, fallback will occur if any of the following are true:

  • You attempted to launch a provider which requires a capability you did not express support for
    • In this case, Trinsic's hosted UI will perform the necessary capability
  • You attempted to launch a provider which requires input, and the input was either not provided or incomplete
    • In this case, Trinsic's hosted UI will collect the necessary input from the user

If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect.

If this field is set to true, you must also:

  1. Set the RedirectUrl field to a non-empty value
  2. Include the LaunchBrowser and CaptureRedirect capabilities in the Capabilities field
providerInput
object | null

Provider-specific input for those providers which require it.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
application/problem+json

Updated 5 months ago