Sign in

v1

latestOpenAPI 3.0.42026-07-2419101123.9 KB
Sessions

Create Hosted Provider Session

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

post/api/v1/sessions/provider/hosted

Request body

providerstring required

The ID of the provider to launch

verificationProfileIdstring uuid required

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

redirectUrlstring required

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

browserLanguagesstring[] nullable

Preferences for languages to show first in the Hosted UI and supported provider launch flows. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English.

Example request

{
  "providerInput": {
    "google-wallet": {
      "preview_raw18013Request": {
        "documentRequests": [
          {
            "documentType": "org.iso.18013.5.1.mDL",
            "nameSpaces": {
              "org.iso.18013.5.1": {
                "given_name": true,
                "family_name": true,
                "portrait": false
              },
              "org.iso.18013.5.1.aamva": {
                "name_suffix": true
              }
            }
          }
        ]
      }
    },
    "apple-wallet": {
      "preview_raw18013Request": {
        "documentRequests": [
          {
            "documentType": "org.iso.18013.5.1.mDL",
            "nameSpaces": {
              "org.iso.18013.5.1": {
                "given_name": true,
                "family_name": true,
                "portrait": false
              },
              "org.iso.18013.5.1.aamva": {
                "name_suffix": true
              }
            }
          }
        ]
      }
    },
    "samsung-wallet": {
      "preview_raw18013Request": {
        "documentRequests": [
          {
            "documentType": "org.iso.18013.5.1.mDL",
            "nameSpaces": {
              "org.iso.18013.5.1": {
                "given_name": true,
                "family_name": true,
                "portrait": false
              },
              "org.iso.18013.5.1.aamva": {
                "name_suffix": true
              }
            }
          }
        ]
      }
    },
    "france-identite": {
      "preview_raw18013Request": {
        "documentRequests": [
          {
            "documentType": "org.iso.18013.5.1.mDL",
            "nameSpaces": {
              "org.iso.18013.5.1": {
                "given_name": true,
                "family_name": true,
                "portrait": false
              },
              "org.iso.18013.5.1.aamva": {
                "name_suffix": true
              }
            }
          }
        ]
      }
    },
    "poland-mobywatel-match": {
      "givenName": "Jan",
      "familyName": "Kowalski",
      "dateOfBirth": "1980-10-20",
      "nationality": "PL",
      "personalNumber": "80102005992",
      "expirationDate": "2030-12-31"
    },
    "bolivia-ci-lookup": {
      "documentNumber": "123456789",
      "dateOfBirth": "1990-03-15"
    },
    "colombia-cc-lookup": {
      "documentNumber": "1234567890",
      "issueDate": "2025-10-31"
    },
    "el-salvador-dui-lookup": {
      "documentNumber": "123456789",
      "dateOfBirth": "1995-12-01"
    },
    "guatemala-cui-lookup": {
      "documentNumber": "1234567890101"
    },
    "panama-cedula-lookup": {
      "documentNumber": "8-1234-12345",
      "dateOfBirth": "1992-03-02"
    },
    "peru-dni-lookup": {
      "documentNumber": "19050215"
    },
    "uk-evisa-lookup": {
      "shareCode": "R9Z3X7K2P"
    },
    "usa-california-dmv": {
      "preview_raw18013Request": {
        "documentRequests": [
          {
            "documentType": "org.iso.18013.5.1.mDL",
            "nameSpaces": {
              "org.iso.18013.5.1": {
                "given_name": true,
                "family_name": true,
                "portrait": false
              },
              "org.iso.18013.5.1.aamva": {
                "name_suffix": true
              }
            }
          }
        ]
      }
    }
  }
}

Response

OK

sessionIdstring uuid required

The ID of the newly-created Acceptance Session

launchUrlstring required

The URL that should be used to launch the Hosted Provider Session on your user's device.

There are two recommended ways to do so:

  • Redirect their browser to the LaunchUrl as a top-level navigation
  • Open a popup window and navigate it to the LaunchUrl

This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.

resultsAccessKeystring required

The resultsAccessKey for the Acceptance Session.

This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.

Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.

Trinsic cannot access a Session's Data Vault without this key.

Example response

{
  "launchUrl": "https://verify.trinsic.id/api/session/launch?clientToken=...",
  "resultsAccessKey": "417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35..."
}