Create verified number

POSThttps://api.tried.com.au/create-verified-number

Needs keys Creates a verified number record for a number in your workspace and enrolls the number in Telnyx Number Reputation. The record starts as pending; check it with Refresh verified number. Real enrollment needs TELNYX_API_KEY and TELNYX_ENTERPRISE_ID. Without a Telnyx key, mock mode stores the record with provider mock and approves it on the first refresh.

Request#

Field	Type	Required	Description
`phone_number`	string	Yes	A number in your workspace, in E.164.
`business_name`	string	Yes	Your registered business name. At least one character.
`contact_email`	string	No	Contact email. Must be a valid email address.
`use_case`	string	No	What you call people about.

Example request#

curl -X POST https://api.tried.com.au/create-verified-number \
  -H "Authorization: Bearer $TRIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14155550123",
    "business_name": "Harbour Dental LLC",
    "contact_email": "ops@harbourdental.example",
    "use_case": "Appointment reminders"
  }'

const res = await fetch("https://api.tried.com.au/create-verified-number", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TRIED_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    phone_number: "+14155550123",
    business_name: "Harbour Dental LLC",
    contact_email: "ops@harbourdental.example",
    use_case: "Appointment reminders",
  }),
});
const verified = await res.json();

import os, requests

res = requests.post(
    "https://api.tried.com.au/create-verified-number",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    json={
        "phone_number": "+14155550123",
        "business_name": "Harbour Dental LLC",
        "contact_email": "ops@harbourdental.example",
        "use_case": "Appointment reminders",
    },
)
verified = res.json()

Response#

201 Created

{
  "verified_number_id": "vnum_3b8d0f6a2c917e45d0b3a8f1",
  "phone_number": "+14155550123",
  "business_name": "Harbour Dental LLC",
  "contact_email": "ops@harbourdental.example",
  "use_case": "Appointment reminders",
  "status": "pending",
  "provider": "telnyx",
  "provider_reference": "9a0e4c71-2f5b-48d3-b6e1-7c3d5f9a2b08",
  "spam_likely": null,
  "created_timestamp": 1792396800000,
  "last_modification_timestamp": 1792396800000
}

Field	Type	Description
`verified_number_id`	string	Record ID, `vnum_` plus 24 hex characters.
`contact_email`	string	Left out when not set.
`use_case`	string	Left out when not set.
`status`	string	`pending`, `approved` or `rejected`.
`provider`	string	`telnyx`, or `mock` in mock mode.
`provider_reference`	string or null	The Telnyx enrollment ID.
`spam_likely`	boolean or null	`null` until a refresh reads a spam risk. Then `true` for any risk other than `low`.
`created_timestamp`	integer	Unix ms.
`last_modification_timestamp`	integer	Unix ms.

Errors#

Status	When
`400`	Body validation failed, for example `contact_email: Invalid email`.
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `numbers` scope. Members get `The member role is read-only`.
`404`	`Phone number ... not found` in this workspace.
`429`	Rate limit exceeded. See Rate limits.
`500`	Telnyx rejected the enrollment, or `TELNYX_ENTERPRISE_ID` is not set.

See Errors for the body format.