Skip to content

Connect WhatsApp

Verification status

Reads the number’s code_verification_status from Meta for one Cloud API channel.

GET/api/v1/channel/{id}/verification
  • Bearer API key
  • Scope: read or write
  • or app session
  • Workspace: X-Tenant-ID (optional with a key)

Path parameters

  • iduuidrequired

    Channel id (from channels[].id).

    Example
    b4c5d6e7-f809-41a2-b3c4-d5e6f7081920

Headers

  • Authorizationstringrequired

    Your API key as Bearer <key>. The word Bearer and the space are case-sensitive. Browser clients signed in to the app use the session cookie instead.

    Constraints
    Keys start with pk_live_ and are 56 characters long.
    Example
    Bearer pk_live_…
  • X-Tenant-IDuuidoptional

    Workspace id. Optional with an API key (a key always acts in its own workspace); if you send it, it must match the key’s workspace. Required with a session cookie. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • channel_iduuid

    Channel id.

  • phone_idstring

    Meta phone number id.

  • waba_idstring

    WhatsApp Business Account id.

  • phonestring

    Saved phone number.

  • statusenum

    Meta’s code_verification_status: VERIFIED, EXPIRED, NOT_VERIFIED or UNKNOWN.

  • verifiedboolean

    true when the number is verified.

  • display_phone_numberstringmay be absent

    Phone number as Meta displays it.

Status codes

  • 200OK. The verification status.
  • 401Unauthorized. The API key is unknown, revoked or expired (invalid or expired API key), or there is no key and no signed-in session (unauthorized).
  • 402Payment required. Only when subscriptions are enforced and the workspace has no active subscription. The body includes code: "payment_required".
  • 403Forbidden. The X-Tenant-ID header or tenant query does not match the API key’s workspace (API key belongs to a different workspace), or a signed-in user is not a member of the workspace (forbidden).
  • 400Bad request. Invalid input, or Meta rejected the request with a 4xx error.
  • 404Not found. No Cloud API channel with this id in the workspace.
  • 502Bad gateway. Meta returned a server error. Errors coming from Meta add meta_code, meta_subcode and meta_title when Meta provides them.