Returns the business verification profile of the workspace and where it is in review. When the deployment requires KYC, the profile must be approved before the workspace can buy numbers, place outbound calls or send SMS. Submit or update it with Submit KYC.
Request#
This endpoint takes no path, query or body parameters.
Example request#
curl https://api.tried.com.au/kyc \
-H "Authorization: Bearer $TRIED_API_KEY"const res = await fetch("https://api.tried.com.au/kyc", {
headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const kyc = await res.json();import os, requests
res = requests.get(
"https://api.tried.com.au/kyc",
headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
kyc = res.json()Response#
200 OK
{
"status": "approved",
"business_name": "Acme Dental Pty Ltd",
"country": "AU",
"website": "https://acmedental.example.com.au",
"submitted_timestamp": 1760313600000,
"reviewed_timestamp": 1760313600000
}Before anything is submitted the response is only:
{ "status": "not_submitted" }| Field | Type | Description |
|---|---|---|
status |
string | not_submitted, pending, approved or rejected. |
business_name |
string | Registered business name. |
country |
string | Two-letter country code of the business. |
website |
string or null | Business website. |
submitted_timestamp |
integer | When the profile was last submitted. |
reviewed_timestamp |
integer or null | When it was approved or rejected. null while pending. |
The registration number, contact email and use case you submit are stored but not returned here.
Errors#
| Status | When |
|---|---|
401 |
Missing or invalid API key. |
403 |
The key's IP allowlist or scopes reject the request. This route needs the admin scope. |
429 |
Rate limit exceeded. See Rate limits. |
See Errors for the body format.