WhatsApp Individual QR Code API

openapi: 3.2.0
info:
  title: Meta Graph API - Application Connected Client Businesses…
  version: v23.0
  description: 'API for retrieving connected client businesses associated with a Meta application.


    This endpoint allows applications to retrieve information about businesses that have

    established client connections through the application. This is essential for managing

    business relationships and understanding client business configurations.'
  contact:
    name: Meta Business Platform Team
    url: https://developers.facebook.com/support
  license:
    name: Meta Platform Terms
    url: https://developers.facebook.com/terms
  termsOfService: https://developers.facebook.com/terms
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com
- url: https://graph.facebook.com
  description: WhatsApp Business Cloud API
- url: https://graph.facebook.com
  description: Meta Graph API production server
tags:
- name: Individual QR Code
  description: APIs for retrieving and deleting individual WhatsApp Business message QR codes
paths:
  /{Version}/{Phone-Number-ID}/message_qrdls/{QR-Code-ID}:
    get:
      summary: Get Individual Message QR Code
      description: 'Retrieve details for a specific QR code by its unique identifier.

        Supports field selection and QR image generation. Response returns QR code in data array for consistency.'
      operationId: getIndividualQrCode
      tags:
      - Individual QR Code
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: Version
        in: path
        required: true
        description: 'Graph API version to use for this request. Determines the API behavior and available features.

          '
        schema:
          type: string
          pattern: ^v[0-9]+\.[0-9]+$
        example: v23.0
      - name: Phone-Number-ID
        in: path
        required: true
        description: 'The WhatsApp Business Account phone number ID that owns the QR code.

          This ID is provided when you add a phone number to your WhatsApp Business Account.

          '
        schema:
          type: string
          pattern: ^[0-9]+$
        example: '1234567890123456'
      - name: QR-Code-ID
        in: path
        required: true
        description: 'The unique 14-character identifier of the QR code to retrieve.

          This is the code value returned when the QR code was created.

          '
        schema:
          type: string
          pattern: ^[A-Z2-7]{14}$
          minLength: 14
          maxLength: 14
        example: ANED2T5QRU7HG1
      - name: fields
        in: query
        required: false
        description: 'Comma-separated list of fields to include in the response. Available fields:

          - code: QR code identifier (always included)

          - prefilled_message: Pre-filled message text (always included)

          - deep_link_url: WhatsApp deep link URL (always included)

          - creation_time: Unix timestamp when QR code was created (first-party apps only)

          - qr_image_url.format(FORMAT): QR code image URL where FORMAT is SVG or PNG


          Example: "code,prefilled_message,qr_image_url.format(SVG)"

          '
        schema:
          type: string
        example: code,prefilled_message,deep_link_url,qr_image_url.format(SVG)
      responses:
        '200':
          description: Successfully retrieved the message QR code details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QrCodeResponse'
              examples:
                default_fields:
                  summary: Default fields response
                  description: Response with default fields (code, prefilled_message, deep_link_url)
                  value:
                    data:
                    - code: ANED2T5QRU7HG1
                      prefilled_message: Show me Cyber Monday deals!
                      deep_link_url: https://wa.me/message/ANED2T5QRU7HG1
                with_qr_image_svg:
                  summary: Response with SVG QR code image
                  description: Response including QR code image URL in SVG format
                  value:
                    data:
                    - code: ANED2T5QRU7HG1
                      prefilled_message: Show me Cyber Monday deals!
                      deep_link_url: https://wa.me/message/ANED2T5QRU7HG1
                      qr_image_url: https://scontent-iad3-1.xx.fbcdn.net/m1/v/t6/An-H7T8OyTqO07lcRGHlKteuPMKDnx07nua3dGb4i560bVxDscweOV4KoKD_4wCDFoHR_C5LyVjxQISKPxwora1bbFhUEo2nA19ZPLBUVoQSmV12l1x-nuu312jKty-5rmojmde_a0g?ccb=10-5&oh=00_AfASq_vjojFza_9A-HDeRgHM3wZ8yjNprpYBjNKOn8RkSg&oe=64550A9E&_nc_sid=f36290
                with_creation_time:
                  summary: Response with creation time (first-party apps only)
                  description: Response including creation timestamp for first-party applications
                  value:
                    data:
                    - code: ANED2T5QRU7HG1
                      prefilled_message: Show me Cyber Monday deals!
                      deep_link_url: https://wa.me/message/ANED2T5QRU7HG1
                      creation_time: 1672531200
        '400':
          description: Bad Request - Invalid QR code ID format or parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Invalid QR code ID format. Expected 14-character alphanumeric string
                  type: OAuthException
                  code: 100
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '401':
          description: Unauthorized - Invalid or missing access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Invalid OAuth access token
                  type: OAuthException
                  code: 190
                  error_subcode: 463
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '403':
          description: Forbidden - Insufficient permissions or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Your app doesn't have permission to access QR codes for this phone number
                  type: OAuthException
                  code: 200
                  error_subcode: 1349174
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  error_user_title: Permission Denied
                  error_user_msg: Your app doesn't have permission to access this resource
        '404':
          description: Not Found - Phone number ID or QR code does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: QR code not found
                  type: GraphMethodException
                  code: 803
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  error_user_title: QR Code Not Found
                  error_user_msg: The QR code you're trying to access doesn't exist or has been deleted
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Too many API calls. Please try again later
                  type: OAuthException
                  code: 4
                  error_subcode: 2446079
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
        '500':
          description: Internal Server Error - Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: An unexpected error occurred. Please retry your request
                  type: GraphMethodException
                  code: 2
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
      security:
      - bearerAuth: []
    delete:
      summary: Delete Individual Message QR Code
      description: 'Permanently delete a specific QR code. Once deleted, the QR code and deep link become invalid.

        Deletion cannot be undone and affects any existing marketing materials using the QR code.'
      operationId: deleteIndividualQrCode
      tags:
      - Individual QR Code
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: Version
        in: path
        required: true
        description: 'Graph API version to use for this request. Determines the API behavior and available features.

          '
        schema:
          type: string
          pattern: ^v[0-9]+\.[0-9]+$
        example: v23.0
      - name: Phone-Number-ID
        in: path
        required: true
        description: 'The WhatsApp Business Account phone number ID that owns the QR code to be deleted.

          This ID is provided when you add a phone number to your WhatsApp Business Account.

          '
        schema:
          type: string
          pattern: ^[0-9]+$
        example: '1234567890123456'
      - name: QR-Code-ID
        in: path
        required: true
        description: 'The unique 14-character identifier of the QR code to delete.

          This is the code value returned when the QR code was created.

          '
        schema:
          type: string
          pattern: ^[A-Z2-7]{14}$
          minLength: 14
          maxLength: 14
        example: ANED2T5QRU7HG1
      responses:
        '200':
          description: Successfully deleted the message QR code
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQrCodeResponse'
              examples:
                successful_deletion:
                  summary: QR code successfully deleted
                  description: Confirmation that the QR code has been permanently deleted
                  value:
                    success: true
        '400':
          description: Bad Request - Invalid QR code ID format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Invalid QR code ID format. Expected 14-character alphanumeric string
                  type: OAuthException
                  code: 100
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '401':
          description: Unauthorized - Invalid or missing access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Invalid OAuth access token
                  type: OAuthException
                  code: 190
                  error_subcode: 463
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '403':
          description: Forbidden - Insufficient permissions or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Your app doesn't have permission to delete QR codes for this phone number
                  type: OAuthException
                  code: 200
                  error_subcode: 1349174
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  error_user_title: Permission Denied
                  error_user_msg: Your app doesn't have permission to access this resource
        '404':
          description: Not Found - Phone number ID or QR code does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              examples:
                qr_code_not_found:
                  summary: QR code not found
                  description: The specified QR code doesn't exist or has already been deleted
                  value:
                    error:
                      message: QR code not found
                      type: GraphMethodException
                      code: 803
                      fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                      error_user_title: QR Code Not Found
                      error_user_msg: The QR code you're trying to delete doesn't exist or has already been deleted
                phone_number_not_found:
                  summary: Phone number not found
                  description: The specified phone number ID doesn't exist or is not accessible
                  value:
                    error:
                      message: Phone number not found
                      type: GraphMethodException
                      code: 803
                      fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                      error_user_title: Phone Number Not Found
                      error_user_msg: The phone number you're trying to access doesn't exist or is not available
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Too many deletion attempts. Please try again later
                  type: OAuthException
                  code: 4
                  error_subcode: 2446079
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
        '500':
          description: Internal Server Error - Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: An unexpected error occurred. Please retry your request
                  type: GraphMethodException
                  code: 2
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
      security:
      - bearerAuth: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: 'Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

        '
      required: true
      schema:
        type: string
        pattern: ^Bearer\s+[A-Za-z0-9\-_.]+.*$
        example: Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...
    UserAgent:
      name: User-Agent
      in: header
      description: The user agent string identifying the client software making the request.
      required: false
      schema:
        type: string
        default: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
        pattern: ^[a-zA-Z0-9\-_]+\/[0-9]+\.[0-9]+\.[0-9]+(;[a-zA-Z0-9\-=\.]+)?(\s+[a-zA-Z0-9\-_]+\/[0-9\-\.]+)?$
        example: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
  schemas:
    QrCodeResponse:
      type: object
      description: Response containing QR code details after creation or update
      required:
      - code
      - prefilled_message
      - deep_link_url
      properties:
        code:
          type: string
          description: 'Unique 14-character identifier for the QR code. This code is used

            for future updates or deletions.

            '
          pattern: ^[A-Z2-7]{14}$
          example: ANED2T5QRU7HG1
        prefilled_message:
          type: string
          description: 'The pre-filled message text associated with this QR code.

            This text appears when customers use the QR code.

            '
          example: Hi! I'm interested in your products. Can you help me?
        deep_link_url:
          type: string
          format: uri
          description: 'WhatsApp deep link URL that can be used directly without QR code scanning.

            Customers can click this link to start a conversation with the pre-filled message.

            '
          example: https://wa.me/message/ANED2T5QRU7HG1
        qr_image_url:
          type: string
          format: uri
          description: 'URL to download the QR code image. Only present if generate_qr_image

            parameter was specified in the request. Image format matches the requested format.

            '
          example: https://scontent-iad3-2.xx.fbcdn.net/m1/v/t6/An-psFmLBls2NFXnhhkSVqwIHEqCTQoNKTLxxlOeci0Wbsukd2RLiwZalHrXwqT5RTFSzOhyw6OLvJJO0itaQtJI1BS2WkNcV67wR3GNx7ZX1tFSNCbpo1e6KPptKF1GbVGzmUfkgSPX?ccb=10-5&oh=00_AfAOAr6oRA2OKV_Ur3GUh4em57sACxUkfhXHsObiFrxOsA&oe=64DCCEF6&_nc_sid=5a413f
    GraphAPIError:
      type: object
      description: Standard Graph API error response
      required:
      - error
      properties:
        error:
          type: object
          required:
          - message
          - type
          - code
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Invalid parameter
            type:
              type: string
              description: Error category type
              example: OAuthException
            code:
              type: integer
              description: Numeric error code
              example: 100
            error_subcode:
              type: integer
              description: More specific error subcode when available
              example: 33
            fbtrace_id:
              type: string
              description: Unique identifier for debugging and support requests with Meta
              example: AXsgnV2Cm3ZMGF3dF_cfYIn
            is_transient:
              type: boolean
              description: Indicates whether this error is temporary and the request should be retried
              example: false
            error_user_title:
              type: string
              description: User-friendly error title for display purposes
              example: Permission Denied
            error_user_msg:
              type: string
              description: User-friendly error message for display purposes
              example: Your app doesn't have permission to access this resource
    DeleteQrCodeResponse:
      type: object
      description: Response confirming successful QR code deletion
      required:
      - success
      properties:
        success:
          type: boolean
          description: Indicates whether the QR code was successfully deleted
          example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'System user access token with whatsapp_business_management permission. Format: Bearer YOUR_SYSTEM_USER_ACCESS_TOKEN

        '