> ## Documentation Index > Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt > Use this file to discover all available pages before exploring further. # Check WhatsApp connection > Indicates whether the instance WhatsApp account is authenticated (paired and active). The `data.connected` field is `true` when a WhatsApp session is logged in. When disconnected, the response is `{ "connected": false }`. When connected, `data` includes live account profile fields in this order: `connected`, `phone`, `whatsapp_jid`, `push_name`, `business_name`, `business_profile`, `profile_picture_id`, `profile_picture_url`, `profile_url`, and optional fields (`verified_name`, `about`, `website`). Empty fields are omitted. ## OpenAPI ````yaml /api-reference/openapi.en.json get /instances/{id}/session/status openapi: 3.1.0 info: title: VZaps public API version: 1.0.0 description: >- Official reference for the VZaps public API: instances, billing, and instance operations (session, webhook, messaging, and more). servers: - url: https://api.vzaps.com description: Production security: [] tags: - name: Health - name: Authentication - name: Instances - name: Billing - name: Session - name: Webhook - name: Chat - name: Usuarios, avatar e contatos description: >- Consultas na rede WhatsApp (info, check), avatar e lista de contatos da conta; nao sao contas de usuario internas da plataforma VZaps. - name: Group - name: Contact - name: Queue - name: TypeBot description: >- Configuracao da integracao TypeBot por instancia (multi-flow, prioridade, sessoes). - name: Chatwoot description: >- Configuracao da integracao Chatwoot por instancia (canal bidirecional WhatsApp <-> Chatwoot). - name: Chats description: >- WhatsApp chat metadata and actions (list, archive, mute, pin, read, clear, and delete). paths: /instances/{id}/session/status: get: tags: - Session summary: Check WhatsApp connection description: >- Indicates whether the instance WhatsApp account is authenticated (paired and active). The `data.connected` field is `true` when a WhatsApp session is logged in. When disconnected, the response is `{ "connected": false }`. When connected, `data` includes live account profile fields in this order: `connected`, `phone`, `whatsapp_jid`, `push_name`, `business_name`, `business_profile`, `profile_picture_id`, `profile_picture_url`, `profile_url`, and optional fields (`verified_name`, `about`, `website`). Empty fields are omitted. operationId: sessionStatus parameters: - $ref: '#/components/parameters/InstanceIdParam' responses: '200': description: WhatsApp connection state and account profile (`data`) content: application/json: schema: $ref: '#/components/schemas/WorkerEnvelopeSessionStatus' security: - bearerAuth: [] - instanceTokenHeader: [] clientTokenHeader: [] components: parameters: InstanceIdParam: name: id in: path required: true description: >- Identificador publico da instancia no formato gerado pela plataforma: prefixo `VZ` seguido de caracteres alfanumericos. schema: type: string example: VZ9K2M4N8P1Q3R5S7T0WABCD01EF schemas: WorkerEnvelopeSessionStatus: allOf: - $ref: '#/components/schemas/WorkerEnvelopeBase' - type: object properties: data: $ref: '#/components/schemas/SessionStatusData' example: code: 200 success: true data: connected: true phone: '551151968302' whatsapp_jid: 551151968302@s.whatsapp.net push_name: Aprova Mesa Prop business_name: Aprova Mesa Prop business_profile: business_hours_timezone: America/Sao_Paulo categories: - id: '1022050661163852' name: Finance profile_options: bot_fields: '' cart_enabled: 'true' commerce_experience: none direct_connection: 'false' is_offerings_eligible: 'true' is_responsive: 'false' profile_picture_id: '1242225976' profile_picture_url: https://pps.whatsapp.net/v/t61.24694-24/example.jpg profile_url: https://wa.me/551151968302 WorkerEnvelopeBase: type: object properties: code: type: integer success: type: boolean required: - code - success SessionStatusData: type: object properties: connected: type: boolean description: >- `true` when the instance WhatsApp account is authenticated; `false` otherwise. Always the first field in `data`. phone: type: string description: >- Phone number of the connected account. Present only when `connected` is `true`. whatsapp_jid: type: string description: >- JID of the connected account. Present only when `connected` is `true`. push_name: type: string description: >- Display name (push name) of the connected account. Present only when `connected` is `true`. business_name: type: string description: >- Business name of the account, when applicable. Present only when `connected` is `true`. business_profile: $ref: '#/components/schemas/SessionStatusBusinessProfile' description: >- Additional business profile details, when applicable. Present only when `connected` is `true`. Subfields in this order: `business_hours_timezone`, `categories`, `profile_options`, `address`, `email`. profile_picture_id: type: string description: Profile picture identifier. Present only when `connected` is `true`. profile_picture_url: type: string format: uri description: >- Profile picture URL of the account. Present only when `connected` is `true`. profile_url: type: string format: uri description: >- Public profile URL for the account (wa.me link). Present only when `connected` is `true`. verified_name: type: string description: >- Verified name of the account, when applicable. Present only when `connected` is `true`. about: type: string description: >- WhatsApp about/status text of the account. Present only when `connected` is `true`. website: type: string format: uri description: >- Website listed on the business profile, when applicable. Present only when `connected` is `true`. required: - connected SessionStatusBusinessProfile: type: object properties: business_hours_timezone: type: string categories: type: array items: $ref: '#/components/schemas/SessionStatusBusinessCategory' profile_options: type: object additionalProperties: type: string address: type: string email: type: string format: email SessionStatusBusinessCategory: type: object properties: id: type: string name: type: string required: - id - name securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT instanceTokenHeader: type: apiKey in: header name: X-Instance-Token clientTokenHeader: type: apiKey in: header name: X-Client-Token ````