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

# Check a number

> Checks the token, the webhook subscription, the registration and the sending state. The answer is kept for ten minutes. Needs the `channels:read` scope.



## OpenAPI

````yaml /openapi/partner.yaml get /api/v1/partner/tenants/{external_ref}/channels/whatsapp/numbers/{pnid}/health/
openapi: 3.1.0
info:
  title: ImpelLabs Partner API
  version: '1'
  description: >-
    The Partner API provisions customer businesses (tenants) and runs their
    channels, conversations and templates from your own product. Call it from
    your server with a partner key. Every path ends with a slash.
servers:
  - url: https://api.impellabs.tech
security:
  - bearer: []
tags:
  - name: Keys
    description: Your partner API keys.
  - name: Tenants
    description: Customer businesses, their channels, conversations and templates.
  - name: Webhooks
    description: Where your tenants' events go.
  - name: WhatsApp sign-up
    description: The settings of the hosted WhatsApp sign-up.
paths:
  /api/v1/partner/tenants/{external_ref}/channels/whatsapp/numbers/{pnid}/health/:
    get:
      tags:
        - Tenants
      summary: Check a number
      description: >-
        Checks the token, the webhook subscription, the registration and the
        sending state. The answer is kept for ten minutes. Needs the
        `channels:read` scope.
      operationId: >-
        get_api_v1_partner_tenants_external_ref_channels_whatsapp_numbers_pnid_health
      parameters:
        - name: external_ref
          in: path
          required: true
          schema:
            type: string
          description: Your own id for the customer business, set when you created it.
        - name: pnid
          in: path
          required: true
          schema:
            type: string
          description: The WhatsApp phone number id (`phone_number_id`).
        - name: refresh
          in: query
          required: false
          description: >-
            Send `true` to ask Meta again. Without it, a result from the last
            ten minutes is returned.
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                phone_number_id: '100000000000001'
                waba_id: '200000000000001'
                payment:
                  method_linked: true
                  reason: meta
                  error: null
                  detail: null
                  billing_url: ''
                can_send_message: AVAILABLE
                problems: []
                token:
                  is_valid: true
                  scopes: []
                  expires_at: null
                  error: null
                subscribed_apps: []
                phone: {}
                needs_registration: false
                cached: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        4XX:
          description: The request is not valid or not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Unauthorized:
      description: The credentials are missing, wrong, expired or revoked.
    Forbidden:
      description: These credentials may not do this.
    NotFound:
      description: There is no such row, or these credentials cannot see it.
  schemas:
    Error:
      type: object
      description: >-
        An error. Most errors carry `detail`. Some carry `error` with `code` and
        `message`.
      properties:
        detail:
          type: string
        code:
          type: string
        field:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.