latestOpenAPI 3.0.32026-08-12367267.0 KB

cda4b2b11372

Get session configuration

This endpoint retrieves the configuration details for a specific session configuration based on the given session config ID.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • sessionConfigId (string, required) – The unique identifier for the session configuration.
post/get-session-config

Request body

companyKeystring
sessionConfigIdstring

Example request

{
  "companyKey": "your-company-secret-key",
  "sessionConfigId": "6162636465666768696a6b6c"
}

Response

Success

Example response

{
  "result": {
    "id": "679c74e4d9725987e3879265",
    "name": "Configuration Template",
    "general": {
      "language": "en",
      "sessionLifetime": 15
    },
    "steps": [
      {
        "title": {
          "en": "ID Verification"
        },
        "type": "identity-document",
        "key": "select_document_id",
        "flags": {
          "documentTypes": [
            "id",
            "passport",
            "driver_license",
            "residence_permit"
          ]
        }
      },
      {
        "title": {
          "en": "Liveness Check"
        },
        "type": "liveness",
        "key": "liveness",
        "flags": {
          "liveness": true,
          "maxLivenessAttempts": 3
        }
      }
    ]
  }
}