---
updatedAt: 2026-07-07T17:42:21.000Z
agentTools:
  projectIndex: https://docs.bynn.com/llms.txt
---

# Show session information

Shows session information.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "BYNN API",
    "description": "The BYNN API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects. To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no “switch” for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test-mode credentials never hit live networks and incur no cost. **AUTHENTICATION:** Please use your **Private API Key** that looks like this `private_Nv7UpwQbSmWtUTiSWfw1bdHm` as the username and password in HTTP basic auth.",
    "termsOfService": "https://bynn.com/terms",
    "contact": {
      "name": "BYNN Development Team",
      "email": "hello@bynn.com",
      "url": "https://docs.bynn.com"
    },
    "license": {
      "name": "BYNN Documentation",
      "url": "https://docs.bynn.com"
    },
    "version": "1.0"
  },
  "tags": [
    {
      "name": "sessions",
      "description": "Operations about sessions"
    }
  ],
  "paths": {
    "/sessions/{session_id}": {
      "get": {
        "summary": "Show session information",
        "description": "Shows session information.",
        "parameters": [
          {
            "in": "path",
            "name": "session_id",
            "description": "Unique session token",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Show session information",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Bynn_V1_Entities_Session"
                }
              }
            }
          },
          "404": {
            "description": "Invalid session",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Bynn_V1_Entities_Error"
                }
              }
            }
          },
          "410": {
            "description": "Session canceled or consent not given",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Bynn_V1_Entities_Error"
                }
              }
            }
          }
        },
        "tags": [
          "sessions"
        ],
        "operationId": "getSessionsSessionId"
      }
    }
  },
  "servers": [
    {
      "url": "//api.bynn.com/v1"
    }
  ],
  "components": {
    "schemas": {
      "Bynn_V1_Entities_Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "example": "validation_error",
                "description": "Type of error"
              },
              "message": {
                "type": "string",
                "example": "Invalid parameters",
                "description": "Error message"
              }
            },
            "required": [
              "type",
              "message"
            ]
          }
        },
        "required": [
          "error"
        ],
        "description": "Bynn_V1_Entities_Error model"
      },
      "Bynn_V1_Entities_Session": {
        "type": "object",
        "properties": {
          "session_id": {
            "type": "string",
            "description": "Unique session token"
          },
          "url": {
            "type": "string",
            "description": "URL to the session"
          },
          "qr_base64_png": {
            "type": "string",
            "description": "QR code image as base64 encoded PNG"
          },
          "branding": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Bynn_V1_Entities_SessionBranding"
              }
            ],
            "description": "Brand configuration parameters for the session."
          },
          "websocket_url": {
            "type": "string",
            "example": "wss://url.com",
            "description": "URL to websocket for event status updates for this specific session"
          }
        },
        "required": [
          "session_id",
          "url",
          "qr_base64_png",
          "branding",
          "websocket_url"
        ],
        "description": "Bynn_V1_Entities_Session model"
      },
      "Bynn_V1_Entities_SessionBranding": {
        "type": "object",
        "properties": {
          "whitelabel": {
            "type": "boolean",
            "example": false,
            "description": "Indicates if Bynn logos shall be hidden."
          },
          "name": {
            "type": "string",
            "example": "Test Company",
            "description": ""
          },
          "jurisdiction": {
            "type": "string",
            "example": "US",
            "description": ""
          },
          "url": {
            "type": "string",
            "example": "https://example.com",
            "description": ""
          },
          "url_data_processing_consent": {
            "type": "string",
            "example": "https://example.com/privacy_consent",
            "description": ""
          },
          "url_terms": {
            "type": "string",
            "example": "https://example.com/terms",
            "description": ""
          },
          "url_privacy": {
            "type": "string",
            "example": "https://example.com/privacy",
            "description": ""
          },
          "text_data_processing_consent": {
            "type": "string",
            "example": "I consent to the collection, processing, and storage of my personal data, including biometric data, for the purpose of identity verification. I understand that my information will be handled securely and in compliance with applicable privacy laws and regulations. For more details, please refer to the Privacy Policy",
            "description": ""
          },
          "url_icon": {
            "type": "string",
            "example": "https://example.com/icon.png",
            "description": "Can be url or base64 encoded (strict) image url"
          },
          "url_logo": {
            "type": "string",
            "example": "https://example.com/icon.png",
            "description": "Can be url or base64 encoded (strict) image url"
          },
          "brand_color": {
            "type": "string",
            "example": "#5156be",
            "description": ""
          },
          "accent_color": {
            "type": "string",
            "example": "#5156be",
            "description": ""
          },
          "web_sdk_return_url": {
            "type": "string",
            "example": "https://example.com/return_back_after_verification?identifier=[identifier]&sessionId=[sessionId]",
            "description": ""
          },
          "is_test": {
            "type": "boolean",
            "example": false,
            "description": "Indicates if this is a test verification."
          }
        },
        "required": [
          "whitelabel",
          "name",
          "jurisdiction",
          "url",
          "url_data_processing_consent",
          "url_terms",
          "url_privacy",
          "text_data_processing_consent",
          "url_icon",
          "url_logo",
          "brand_color",
          "accent_color",
          "web_sdk_return_url",
          "is_test"
        ]
      }
    }
  }
}
```