> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Check on WhatsApp

> Checks whether the given phone numbers are registered on WhatsApp.



## OpenAPI

````yaml openapi.evolution-go.json POST /user/check
openapi: 3.1.0
info:
  title: Evolution GO Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution GO. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-go`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key) or `Authorization: Bearer`.
    Instance/session endpoints are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-go
security:
  - apiKey: []
tags:
  - name: Call (voice)
  - name: Chat
  - name: Community
  - name: Group
  - name: Label
  - name: Message
  - name: Newsletter / Channels
  - name: Send (load-balanced)
  - name: User / Contacts
paths:
  /user/check:
    post:
      tags:
        - User / Contacts
      summary: Check on WhatsApp
      description: Checks whether the given phone numbers are registered on WhatsApp.
      operationId: post__user_check
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                number:
                  type: array
                  items:
                    type: string
                  description: Phone numbers in international format to verify.
                  example:
                    - '5511999999999'
                    - '5511888888888'
                formatJid:
                  type: boolean
                  description: When true, returns each result keyed by formatted JID.
                  example: false
              required:
                - number
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Whatsmeow IsOnWhatsApp result wrapped in the Evolution GO
                  envelope.
                properties:
                  message:
                    type: string
                    description: Operation status message.
                  data:
                    type: object
                    description: CheckUserCollection returned by the service.
                    properties:
                      Users:
                        type: array
                        description: One entry per queried number.
                        items:
                          type: object
                          properties:
                            Query:
                              type: string
                              description: >-
                                The original number/query string that was
                                checked.
                            IsInWhatsapp:
                              type: boolean
                              description: Whether the number is registered on WhatsApp.
                            JID:
                              type: string
                              description: Canonical user JID returned by WhatsApp.
                            RemoteJID:
                              type: string
                              description: >-
                                JID to use for messaging (WhatsApp JID when
                                found, else the original query).
                            LID:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Associated LID (local ID) JID, if resolvable;
                                otherwise null.
                            VerifiedName:
                              type: string
                              description: >-
                                Verified business name, empty string for
                                non-business accounts.
              example:
                message: success
                data:
                  Users:
                    - Query: '5511999999999'
                      IsInWhatsapp: true
                      JID: 5511999999999@s.whatsapp.net
                      RemoteJID: 5511999999999@s.whatsapp.net
                      LID: 274445566677889@lid
                      VerifiedName: ''
                    - Query: '5511888888888'
                      IsInWhatsapp: false
                      JID: 5511888888888@s.whatsapp.net
                      RemoteJID: '5511888888888'
                      LID: null
                      VerifiedName: ''
        default:
          description: Error — provider or layer error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````