> ## Documentation Index > Fetch the complete documentation index at: https://docs.tawked.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview the screening > The verdict two brand names would get, and what would happen next under your approval mode, without creating anything: whether a provision would wait for a decision, and whether that decision is yours or Tawked's. Warn the merchant at signup instead of after. Guide: [Applications](https://docs.tawked.com/partners/applications.md) ## OpenAPI ````yaml https://tawked.com/openapi.json post /v1/partner/screening openapi: 3.1.0 info: title: Tawked API version: 2026-09 summary: >- Tawked Verify: OTP verification for Saudi mobile numbers over SMS, in two calls. Tawked Notifications: WhatsApp template messages from the application's own number. Tawked Email: transactional e-mail from the application's own verified domain. Tawked Chat: the conversation menus a connected app adds beside the conversations of its connection's application, and the auto-attendant it sets up there. The Partner API for platforms that run Tawked Verify for their merchants. description: >- The public API of Tawked, a Saudi messaging platform: Tawked Verify (one-time codes), Tawked Notifications (WhatsApp templates from the application's own number), Tawked Email (transactional e-mail from the application's own domain) and the Partner API. Tawked Verify is an OTP verification API for Saudi numbers. One call sends a one-time code by SMS to a Saudi mobile number, and a second call checks it. SAR 0.09 per SMS code sent, prepaid; a send the network refuses is refunded. Authenticate with a Bearer API key from the dashboard (tk_live_ for production, tk_test_ for the sandbox, tk_partner_ for partners, tk_partner_test_ for the partner sandbox). Partners (tk_partner_) provision a Verify application per merchant under /v1/partner/applications and name it as application on every Verify call. Both /v1/... and /api/v1/... answer identically. Rate limit: 120 requests per minute per key. termsOfService: https://tawked.com/en/terms license: name: Proprietary (Tawked terms of service) url: https://tawked.com/en/terms contact: name: Tawked support email: support@tawked.com url: https://tawked.com/en/contact servers: - url: https://tawked.com description: Production (the sandbox is a tk_test_ key on the same host) - url: https://tawked.com/api description: The same API under /api/v1/..., kept for older integrations security: - bearerKey: [] - headerKey: [] tags: - name: Verify x-group: Verify description: Send and check one-time codes. - name: WhatsApp x-group: Notifications description: >- Tawked Notifications: send approved WhatsApp templates through the number connected to an application. An application in review or approved connects its own number from the dashboard. - name: Email x-group: Email description: >- Tawked Email: send transactional e-mail from an address on a verified domain of the application, to up to 50 recipients a message, in batches or scheduled, and read and list what was sent. Live keys only. - name: Chat x-group: Chat description: >- Tawked Chat: the conversation menus a connected app adds beside the conversations of its connection's application, and reads, changes and removes, with `chat:menus`; and the application's auto-attendant, which a connected app sets up, publishes and switches on or off, with `chat:attendant`. A connected app's key only; a business adds its own menus and builds its auto-attendant in the console. - name: Partner x-group: Partner API description: >- For platforms that run Tawked Verify for their merchants: provision a Verify application per merchant, keep its brand and verify settings current, switch it off and on, and read usage and the code log. Partner keys (tk_partner_) only; every Verify operation then takes `application` with the partner's own id for the application. - name: Webhooks x-group: Webhooks description: >- The events Tawked sends to your endpoint: an application's verification outcomes and message statuses, and a partner account's lifecycle, balance and opt-in verification events. Every delivery is signed the same way and retried the same way. externalDocs: description: Developer docs, with code samples url: https://docs.tawked.com paths: /v1/partner/screening: post: tags: - Partner summary: Preview the screening description: >- The verdict two brand names would get, and what would happen next under your approval mode, without creating anything: whether a provision would wait for a decision, and whether that decision is yours or Tawked's. Warn the merchant at signup instead of after. operationId: partner_screening requestBody: required: true content: application/json: schema: type: object properties: name_ar: type: string description: The Arabic brand name, 1 to 80 characters. name_en: type: string description: The English brand name, 1 to 80 characters. required: - name_ar - name_en responses: '200': description: Clean, you decide / Flagged, Tawked decides / Active at once content: application/json: schema: type: object properties: result: type: string rules: type: array items: type: - string - 'null' review: type: object properties: needed: type: boolean decided_by: type: - string - 'null' examples: clean_you_decide: summary: Clean, you decide value: result: clean rules: [] review: needed: true decided_by: partner flagged_tawked_decides: summary: Flagged, Tawked decides value: result: flagged rules: - protected_brand:banks:alrajhi review: needed: true decided_by: tawked active_at_once: summary: Active at once value: result: clean rules: [] review: needed: false decided_by: null '400': description: >- `invalid_json`: The request body is not valid JSON.; `invalid_request`: A field is missing or refused. `fields` names them: bare names on the verify-settings endpoint (`verify` alone for an empty or unrecognised patch), `verify.` followed by the field name for a setting refused on provision or a brand update, `metadata.` followed by the key for a refused tag (`metadata` alone for a wrong shape, on a write or on the list filter), `logo` for a missing, oversized or non-image file, `events` for an unknown event name, `url` or `secret` on the webhook (console-only, with `message`), `cursor`, `since`, `event` or `status` on the feeds; on usage, `message` says that `from` and `to` must be ISO dates; a malformed `Idempotency-Key` header is refused with `message` too. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - invalid_json - invalid_request '401': description: >- `unauthorized`: Missing, unknown or revoked key; a key of another mode (`tk_live_` and `tk_test_` keys cannot call the partner API); or a partner account Tawked suspended.; `key_expired`: The key's `expires_at` has passed. Checked right after the key is recognised. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - unauthorized - key_expired '403': description: '`ip_not_allowed`: The caller''s IP is outside the key''s allowlist.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - ip_not_allowed '429': description: >- `too_many_requests`: Per-key rate limit exceeded (120 requests per minute, fixed 60-second window). Checked before authentication. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - too_many_requests '500': description: >- `internal_error`: An unhandled server error. Quote the X-Request-Id header if you report it. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - properties: error: enum: - internal_error x-codeSamples: - lang: bash label: cURL source: |- curl -X POST https://tawked.com/v1/partner/screening \ -H "Authorization: Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "name_ar": "متجر الورد", "name_en": "Flower Shop" }' - lang: javascript label: Node.js source: |- const res = await fetch("https://tawked.com/v1/partner/screening", { method: "POST", headers: { Authorization: "Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx", "Content-Type": "application/json", }, body: JSON.stringify({ "name_ar": "متجر الورد", "name_en": "Flower Shop" }), }); const data = await res.json(); - lang: python label: Python source: |- import requests res = requests.post( "https://tawked.com/v1/partner/screening", headers={"Authorization": "Bearer tk_partner_xxxxxxxxxxxxxxxxxxxx"}, json={ "name_ar": "متجر الورد", "name_en": "Flower Shop" }, ) data = res.json() components: schemas: Error: type: object required: - error properties: error: type: string description: A stable machine-readable code; the docs list every one. additionalProperties: true securitySchemes: bearerKey: type: http scheme: bearer description: >- Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret. headerKey: type: apiKey in: header name: x-api-key description: >- The same API key, with the same access, as a header, for clients that cannot set Authorization. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.