Workspace

Ask

POSThttps://api.vaakyo.com/api/v1/caller-id

Ask for Truecaller verification of one of the workspace’s numbers: the brand name callers see (3-40 characters), a square logo (PNG or JPEG, under 2 MB, at least 200×200), the business category and the usual reason for calling. The platform team reviews it; fees start once verified.

Authorization

A signed-in member with the numbers.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearernumbers.manage

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body multipart/form-data

numberstringrequired

6 to 20 characters

brand_namestringrequired

3 to 40 characters

categorystringrequired

call_reasonstring

at most 100 characters

websitestring

at most 200 characters

logofilerequired

Response

201Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request POST \
  --url 'https://api.vaakyo.com/api/v1/caller-id?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --form 'number=' \
  --form 'brand_name=' \
  --form 'category=' \
  --form 'call_reason=' \
  --form 'website=' \
  --form 'logo=@file.pdf'

import requests

url = "https://api.vaakyo.com/api/v1/caller-id"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
data = {
    "number": "",
    "brand_name": "",
    "category": "",
    "call_reason": "",
    "website": "",
}
files = {"logo": open("file.pdf", "rb")}

response = requests.post(url, params=params, headers=headers, data=data, files=files)
print(response.status_code, response.json())

const form = new FormData()
form.append("number", "")
form.append("brand_name", "")
form.append("category", "")
form.append("call_reason", "")
form.append("website", "")
form.append("logo", fileInput.files[0])

const response = await fetch("https://api.vaakyo.com/api/v1/caller-id?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
  },
  body: form,
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (numbers.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}