tk_partner_ key that covers every client application, and an application per merchant addressed by the partner’s own id for it, the external_id. A client application is Verify only: one-time codes by SMS from Tawked’s sender ID, with the merchant’s reviewed brand named in the text.
A partner account is also a normal Tawked account for its own business. Its own applications, with Verify, Notifications and Chat, are managed in the console like any other account’s, with their own keys; this API is about the applications it opens for its clients.
Partner quickstart
From an empty account to a test code on your phone and a verified webhook, in code.
Applications
Provision one per merchant, keep its brand and verify settings current, switch it off and on, read usage.
Sending codes for an application
The
application field on every Verify call, and what blocks a send.Events
Every event, which ones reach your webhook, and the feed to poll or catch up from.
Partner webhooks
The envelope, the signature, the retries, and the delivery log by API.
Errors
Every code the partner API answers, what to do and whether to retry.
Who holds what
The lifecycle of an application
Getting started
1
Get a partner account
Partner accounts are opened by Tawked, not by signup. Write to support@tawked.com with what you run and how many merchants you expect. You sign in with your phone like any account; the console holds your own applications, and its Clients place holds the applications you open for your merchants. Add your people under Members. The owner always manages Clients; anyone else opens it only with the read or manage access set for them on Members.
2
Create your key
The owner, or whoever manages the clients: Clients → API and webhook, Partner key, Create the key. The key is shown once; you can give it an expiry and an IP allowlist, and it always has full access: a partner key cannot be narrowed to a product. Create a new key stops the current one in the same step, with no overlap window, so rotate from where you can update the secret at once.
3
Set your webhook
Clients → API and webhook, Webhook: an HTTPS URL, a signing secret revealed on demand and rotatable, the events you choose, and a low-balance threshold in halalas. See Partner webhooks.
4
Provision an application per merchant
POST /v1/partner/applications with your external_id, the Arabic and English brand names and the website. The answer says whether the application is active already or in review; service.approved or service.rejected tells your backend the outcome.5
Send codes on the application's behalf
Every Verify call takes
application with your external_id. See Sending codes for an application.Start with the profile
GET /v1/partner/profile says who the key belongs to and what to expect: the approval mode (whether a provision waits for a human, and whose decision it is), the price of a code for your account, the balance, the rate limit, the key in use with its expiry and allowlist, and whether a webhook is configured. An agent reads it before its first provision.
The shape of the partner API
The full reference, each page with a playground: Get the profile, Preview the screening, Provision an application, Provision in bulk, List applications, Get an application, Get the history, Update the brand, Upload the logo, Remove the logo, Update the verify settings, Suspend, Resume, Unpause, Archive, Restore, Get usage, List verifications, Get the event feed, Get the webhook, Update the webhook, List deliveries, Retry a delivery.
To try the flow before anything is approved, create a sandbox key (
tk_partner_test_) under Clients → API and webhook, Sandbox key: provision a test merchant with the live key, then send with the sandbox key to your own verified phone, stamped and capped. See The sandbox key, or follow the Partner quickstart.