v1.0.0 · REST · JSON · read-only
TrustCheck API
Check Ghana businesses, phone and MoMo numbers, social handles, websites, official scam alerts and licences from your own app. One key, one JSON shape, a free sandbox.
Quickstart
- Get a key. Open API keys in your business dashboard and create a test key (free) or a live key (Premium plan). Copy it: it is shown once.
- Make a request. Send the key in the Authorization header. This works right now with the public demo key:
curl "https://trustcheckapp.com/api/v1/checks/phone/0200000001" \
-H "Authorization: Bearer tc_test_demo_public_sandbox_key"- Go live. Swap the tc_test_ key for a tc_live_ key. Nothing else changes: live and sandbox answers have exactly the same shape.
Base URL: https://trustcheckapp.com/api/v1
Authentication
Every request needs a key in the Authorization header:
Authorization: Bearer tc_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX- tc_live_ keys read real TrustCheck data and need the Premium plan. tc_test_ keys read the sandbox and work on any business account.
- Keep live keys on your server. Never put them in a website, an app bundle or a public repository. If a key leaks, revoke it on the dashboard and make a new one.
- An account can hold 5 keys. Use one per app or environment, so you can revoke one without touching the others.
- Keys are stored hashed: we cannot show a key again after you create it.
Sandbox and test keys
Test keys (and the public demo key) return fixed, fictional data: businesses named "Test …", .test websites and Ghana numbers in the unused 020 000 000x range. Use these values to see every kind of answer:
| Request | Sandbox answer |
|---|---|
GET /checks/phone/0200000001 | reported: 2 scam reports |
GET /checks/phone/0200000000 | no reports |
GET /checks/website/scam-shop.test | reported, with an official warning |
GET /checks/instagram/test_fashion_hub | no reports, matches a listed business |
GET /businesses | 6 test businesses, from Excellent to Poor, one with no reviews yet |
GET /licences?q=test | 3 licensed entries and 1 warning |
Any other valid phone, handle or website returns no reports in the sandbox. The demo key allows 30 requests a minute per address; your own test key allows 60 a minute and 2,000 a day.
Responses
Every success has data and meta. meta.mode says whether the answer is live or test. Lists also have meta.pagination and links.
{
"data": { "object": "business", "id": 9001, "slug": "test-bakery-accra", ... },
"meta": { "mode": "test" }
}- Every object has an object field (business, review, check, scam_alert, licence…).
- Times are UTC in ISO 8601 (2026-11-15T09:12:44Z); dates are YYYY-MM-DD. Money is in Ghana cedis, in fields ending _ghs.
- A field with no value is null, never missing. New fields can appear at any time; ignore the ones you do not know.
- Every response has an X-Request-Id header. Quote it when you contact us.
Errors
Errors use HTTP status codes and one JSON shape. Branch on error.code; show error.message to developers, not end users.
{
"error": {
"type": "invalid_request_error",
"code": "invalid_parameter",
"message": "per_page must be a whole number from 1 to 100.",
"param": "per_page",
"doc_url": "https://trustcheckapp.com/developers/docs#error-invalid_parameter"
},
"request_id": "req_4f9a1c2b7e8d3a6f5b0c"
}| code | HTTP | Meaning |
|---|---|---|
missing_api_key | 401 | No key in the Authorization header. |
invalid_api_key | 401 | The key is wrong, deleted or revoked. |
plan_required | 403 | A live key whose account is not on the Premium plan. Test keys keep working. |
live_key_required | 403 | A test key on the legacy /score or /search endpoints, which only read live data. |
invalid_parameter | 400 | A parameter has the wrong type or range; param names it. |
unknown_parameter | 400 | A parameter the endpoint does not take (often a typo). |
missing_parameter | 400 | A required parameter is missing. |
invalid_identifier | 400 | The phone number, handle or website is not valid. |
unrecognised_identifier | 400 | GET /checks could not tell what the query is; send type. |
resource_not_found | 404 | No business, alert or licence holder with that identifier. |
route_not_found | 404 | No endpoint at that path. |
method_not_allowed | 400 | The API is read-only: use GET. |
rate_limited | 429 | Too many requests this minute; wait for Retry-After seconds. |
daily_limit_reached | 429 | A test key used its daily sandbox requests. |
internal_error | 500 | Our fault. Retry; send the request_id if it repeats. |
Rate limits
| Key | Per minute | Per day |
|---|---|---|
| tc_live_ (Premium) | 120 | No daily cap |
| tc_test_ | 60 | 2,000 |
| Public demo key (per IP address) | 30 | — |
Each response tells you where you are: X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time). Over the limit you get 429 rate_limited with a Retry-After header: wait that many seconds, then retry. Need more? Contact us.
Pagination and filters
Lists take page (from 1) and per_page (1 to 100, default 20). Follow links.next until it is null, or read meta.pagination.total_pages.
"meta": { "mode": "live", "pagination": { "page": 2, "per_page": 20, "total": 97, "total_pages": 5 } },
"links": { "self": "…?page=2", "first": "…?page=1", "prev": "…?page=1", "next": "…?page=3", "last": "…?page=5" }Filters are query parameters listed under each endpoint. sort takes a field name; a leading minus sorts descending (sort=-trust_score). An unknown parameter is an error, so typos never fail silently.
Versioning and changes
The version is in the path (/api/v1). Inside v1 we only add things: new endpoints, new optional parameters, new fields and new enum values. Anything that would break your code goes into v2, announced at least 90 days ahead.
v1.0.0 · 15 Nov 2026 · Businesses, reviews, trust scores, categories, checks, scam alerts, licences, sandbox, OpenAPI and Postman.
Businesses
/businesses
List and search businesses
Approved businesses on TrustCheck, best trust score first. Search by name or website, filter by category, verification or minimum score.
| Parameter | In | Type | Description |
|---|---|---|---|
q |
query | string | Text in the name or website, 2 to 100 characters. |
category |
query | integer | Category id from GET /categories. |
verified |
query | boolean | true: only businesses whose documents TrustCheck checked. |
min_score |
query | integer | Lowest trust score, 0 to 100. |
sort |
query | string | Sort field; a leading minus means descending. Default -trust_score. One of: -trust_score, trust_score, name, -name, -review_count, review_count, -created_at, created_at |
page |
query | integer | Page number, from 1. Default 1. |
per_page |
query | integer | Items per page, 1 to 100. Default 20. |
curl "https://trustcheckapp.com/api/v1/businesses?q=bakery" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/businesses?q=bakery", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/businesses?q=bakery",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/businesses?q=bakery");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": [
{
"object": "business",
"id": 9001,
"slug": "test-bakery-accra",
"name": "Test Bakery Accra",
"website": "https://bakery.test",
"category": {
"id": 1,
"name": "Food & Drink"
},
"trust_score": {
"value": 88,
"max": 100,
"label": "Excellent"
},
"rating": {
"average": 4.67,
"count": 3
},
"verified": true,
"verified_at": "2026-09-02T10:00:00Z",
"claimed": true,
"response_rate": 100.0,
"profile_url": "https://trustcheckapp.com/developers/docs#sandbox",
"review_url": "https://trustcheckapp.com/developers/docs#sandbox",
"created_at": "2026-05-14T09:30:00Z",
"updated_at": "2026-11-14T00:00:00Z"
}
],
"meta": {
"mode": "test",
"pagination": {
"page": 1,
"per_page": 20,
"total": 1,
"total_pages": 1
}
},
"links": {
"self": "https://trustcheckapp.com/api/v1/businesses?page=1",
"first": "https://trustcheckapp.com/api/v1/businesses?page=1",
"prev": null,
"next": null,
"last": "https://trustcheckapp.com/api/v1/businesses?page=1"
}
}
/businesses/{business}
Get a business
One business: trust score and label, average rating and review count, verification, claim status, response rate and links.
| Parameter | In | Type | Description |
|---|---|---|---|
business required |
path | string | The business slug (e.g. test-bakery-accra) or its numeric id. |
curl "https://trustcheckapp.com/api/v1/businesses/test-bakery-accra" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/businesses/test-bakery-accra", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/businesses/test-bakery-accra",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/businesses/test-bakery-accra");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "business",
"id": 9001,
"slug": "test-bakery-accra",
"name": "Test Bakery Accra",
"website": "https://bakery.test",
"category": {
"id": 1,
"name": "Food & Drink"
},
"trust_score": {
"value": 88,
"max": 100,
"label": "Excellent"
},
"rating": {
"average": 4.67,
"count": 3
},
"verified": true,
"verified_at": "2026-09-02T10:00:00Z",
"claimed": true,
"response_rate": 100.0,
"profile_url": "https://trustcheckapp.com/developers/docs#sandbox",
"review_url": "https://trustcheckapp.com/developers/docs#sandbox",
"created_at": "2026-05-14T09:30:00Z",
"updated_at": "2026-11-14T00:00:00Z"
},
"meta": {
"mode": "test"
}
}
/businesses/{business}/reviews
List a business's reviews
Published reviews, newest first, with the business's official reply. Reviewers appear as first name and initial; anonymous reviews stay anonymous.
| Parameter | In | Type | Description |
|---|---|---|---|
business required |
path | string | The business slug (e.g. test-bakery-accra) or its numeric id. |
rating |
query | integer | Only reviews with this many stars, 1 to 5. |
sort |
query | string | Default -created_at. One of: -created_at, created_at, -rating, rating |
page |
query | integer | Page number, from 1. Default 1. |
per_page |
query | integer | Items per page, 1 to 100. Default 20. |
curl "https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": [
{
"object": "review",
"id": 70001,
"business_id": 9001,
"rating": 5,
"text": "Fresh bread every morning and they deliver on time. Test review.",
"reviewer": {
"name": "Ama K."
},
"verified_purchase": true,
"source": "trustcheck",
"reply": {
"text": "Thank you, Ama. See you tomorrow!",
"created_at": "2026-11-12T08:10:00Z"
},
"created_at": "2026-11-12T08:10:00Z"
},
{
"object": "review",
"id": 70002,
"business_id": 9001,
"rating": 5,
"text": "The meat pies are the best in the area. Test review.",
"reviewer": {
"name": "Kwame O."
},
"verified_purchase": false,
"source": "trustcheck",
"reply": null,
"created_at": "2026-11-03T17:45:00Z"
},
{
"object": "review",
"id": 70003,
"business_id": 9001,
"rating": 4,
"text": "Good cakes, but the shop was busy on Saturday. Test review.",
"reviewer": {
"name": "Efua M."
},
"verified_purchase": true,
"source": "imported",
"reply": null,
"created_at": "2026-10-21T12:00:00Z"
}
],
"meta": {
"mode": "test",
"pagination": {
"page": 1,
"per_page": 20,
"total": 3,
"total_pages": 1
}
},
"links": {
"self": "https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews?page=1",
"first": "https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews?page=1",
"prev": null,
"next": null,
"last": "https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/reviews?page=1"
}
}
/businesses/{business}/trust-score
Get a trust score with its parts
The 100-point trust score and the five parts it is made of (rating 30, review volume 20, replies 20, verification 20, open disputes 10), with the inputs used.
| Parameter | In | Type | Description |
|---|---|---|---|
business required |
path | string | The business slug (e.g. test-bakery-accra) or its numeric id. |
curl "https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/trust-score" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/trust-score", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/trust-score",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/businesses/test-bakery-accra/trust-score");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "trust_score",
"business_id": 9001,
"business_slug": "test-bakery-accra",
"value": 88,
"max": 100,
"label": "Excellent",
"components": [
{
"key": "rating",
"label": "Average rating",
"points": 28,
"max": 30
},
{
"key": "volume",
"label": "Number of reviews",
"points": 1,
"max": 20
},
{
"key": "response",
"label": "Replies to reviews",
"points": 20,
"max": 20
},
{
"key": "verification",
"label": "Documents checked by TrustCheck",
"points": 20,
"max": 20
},
{
"key": "disputes",
"label": "No open disputes",
"points": 10,
"max": 10
}
],
"inputs": {
"review_count": 3,
"average_rating": 4.67,
"response_rate": 100.0,
"open_disputes": 0,
"verified": true
},
"updated_at": "2026-11-14T00:00:00Z"
},
"meta": {
"mode": "test"
}
}
/categories
List categories
Business categories with the number of approved businesses in each. Use the id to filter GET /businesses.
curl "https://trustcheckapp.com/api/v1/categories" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/categories", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/categories",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/categories");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": [
{
"object": "category",
"id": 1,
"name": "Food & Drink",
"business_count": 2
},
{
"object": "category",
"id": 2,
"name": "Phones & Electronics",
"business_count": 2
},
{
"object": "category",
"id": 3,
"name": "Fashion",
"business_count": 1
},
{
"object": "category",
"id": 4,
"name": "Finance",
"business_count": 1
}
],
"meta": {
"mode": "test",
"count": 4
}
}
Checks
/checks/{type}/{value}
Check a phone number, social handle or website
What TrustCheck knows about a Ghana phone/MoMo number, an Instagram, TikTok or Facebook handle, or a website: published scam reports (count, categories, money lost, dates, what happened), official warnings that name it, and listed businesses that use it. Reporters are never identified. verdict is "reported" or "no_reports"; no reports is not proof of safety.
| Parameter | In | Type | Description |
|---|---|---|---|
type required |
path | string | What the value is. One of: phone, instagram, tiktok, facebook, website |
value required |
path | string | The number (any common format: 0244123456, +233 24 412 3456), handle (with or without @, or a profile link) or website (domain or URL, URL-encoded). |
curl "https://trustcheckapp.com/api/v1/checks/phone/0200000001" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/checks/phone/0200000001", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/checks/phone/0200000001",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/checks/phone/0200000001");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "check",
"type": "phone",
"value": "233200000001",
"display": "020 000 0001",
"verdict": "reported",
"reports": {
"count": 2,
"pending_review": 1,
"total_amount_lost_ghs": 1350.0,
"first_incident_on": "2026-10-18",
"last_incident_on": "2026-11-02",
"categories": [
{
"key": "delivery_fee",
"label": "Fake delivery fee or rider",
"count": 1
},
{
"key": "non_delivery",
"label": "Paid, item never arrived",
"count": 1
}
],
"items": [
{
"category": "delivery_fee",
"category_label": "Fake delivery fee or rider",
"amount_lost_ghs": 150.0,
"incident_date": "2026-11-02",
"description": "Asked for a delivery fee by MoMo, then blocked me. Test report.",
"published_at": "2026-11-03T10:00:00Z"
},
{
"category": "non_delivery",
"category_label": "Paid, item never arrived",
"amount_lost_ghs": 1200.0,
"incident_date": "2026-10-18",
"description": "Paid for a phone advertised on Instagram, nothing was sent. Test report.",
"published_at": "2026-10-20T15:30:00Z"
}
]
},
"official_warnings": [],
"matched_businesses": [],
"phone": {
"local_format": "0200000001",
"network": "Telecel"
},
"check_url": "https://trustcheckapp.com/developers/docs#sandbox",
"report_url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"meta": {
"mode": "test"
}
}
/checks
Check anything (type detected)
Same as /checks/{type}/{value}, but TrustCheck works out what the text is: a phone number, a social profile link or @handle (Instagram unless you send type), or a website.
| Parameter | In | Type | Description |
|---|---|---|---|
query required |
query | string | The number, link, @handle or website, 2 to 300 characters. |
type |
query | string | Optional: skip detection and treat query as this type. One of: phone, instagram, tiktok, facebook, website |
curl "https://trustcheckapp.com/api/v1/checks?query=scam-shop.test" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/checks?query=scam-shop.test", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/checks?query=scam-shop.test",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/checks?query=scam-shop.test");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "check",
"type": "website",
"value": "scam-shop.test",
"display": "scam-shop.test",
"verdict": "reported",
"reports": {
"count": 1,
"pending_review": 0,
"total_amount_lost_ghs": 640.0,
"first_incident_on": "2026-09-30",
"last_incident_on": "2026-09-30",
"categories": [
{
"key": "fake_item",
"label": "Fake or different item",
"count": 1
}
],
"items": [
{
"category": "fake_item",
"category_label": "Fake or different item",
"amount_lost_ghs": 640.0,
"incident_date": "2026-09-30",
"description": "Ordered sneakers, received a fake pair. Test report.",
"published_at": "2026-10-01T09:00:00Z"
}
]
},
"official_warnings": [
{
"object": "scam_alert",
"id": 503,
"title": "Test alert: scam-shop.test sells fake sneakers",
"summary": "A test warning naming a website, so the check endpoint shows an official warning. Test notice.",
"issuer": "Sandbox regulator",
"category": {
"key": "online_shopping",
"label": "Online shopping"
},
"entities_named": [
"scam-shop.test"
],
"source": {
"name": "TrustCheck sandbox",
"url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"published_on": "2026-10-02"
}
],
"matched_businesses": [],
"phone": null,
"check_url": "https://trustcheckapp.com/developers/docs#sandbox",
"report_url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"meta": {
"mode": "test"
}
}
Scam Watch
/scam-alerts
List official scam alerts
Warnings published by regulators, the police and banks (Scam Watch), newest first, with the source link.
| Parameter | In | Type | Description |
|---|---|---|---|
q |
query | string | Text in the title, summary or names, 2 to 100 characters. |
category |
query | string | Alert category. One of: investment, loan_app, momo, impersonation, jobs, online_shopping, account_hack, other |
since |
query | string | Only alerts published on or after this date (YYYY-MM-DD). |
page |
query | integer | Page number, from 1. Default 1. |
per_page |
query | integer | Items per page, 1 to 100. Default 20. |
curl "https://trustcheckapp.com/api/v1/scam-alerts" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/scam-alerts", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/scam-alerts",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/scam-alerts");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": [
{
"object": "scam_alert",
"id": 501,
"title": "Test alert: fake loan app asks for an upfront fee",
"summary": "A test notice used by the sandbox. Real alerts come from regulators and the police.",
"issuer": "Sandbox regulator",
"category": {
"key": "loan_app",
"label": "Loan apps"
},
"entities_named": [
"QuickCash Test"
],
"source": {
"name": "TrustCheck sandbox",
"url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"published_on": "2026-11-12"
},
{
"object": "scam_alert",
"id": 502,
"title": "Test alert: MoMo reversal calls",
"summary": "Callers claim money was sent by mistake and ask for it back. Test notice.",
"issuer": "Sandbox regulator",
"category": {
"key": "momo",
"label": "Mobile money"
},
"entities_named": [],
"source": {
"name": "TrustCheck sandbox",
"url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"published_on": "2026-11-05"
}
],
"meta": {
"mode": "test",
"pagination": {
"page": 1,
"per_page": 20,
"total": 4,
"total_pages": 1
}
},
"links": {
"self": "https://trustcheckapp.com/api/v1/scam-alerts?page=1",
"first": "https://trustcheckapp.com/api/v1/scam-alerts?page=1",
"prev": null,
"next": null,
"last": "https://trustcheckapp.com/api/v1/scam-alerts?page=1"
}
}
/scam-alerts/{id}
Get a scam alert
One official alert by id.
| Parameter | In | Type | Description |
|---|---|---|---|
id required |
path | integer | The alert id. |
curl "https://trustcheckapp.com/api/v1/scam-alerts/501" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/scam-alerts/501", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/scam-alerts/501",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/scam-alerts/501");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "scam_alert",
"id": 501,
"title": "Test alert: fake loan app asks for an upfront fee",
"summary": "A test notice used by the sandbox. Real alerts come from regulators and the police.",
"issuer": "Sandbox regulator",
"category": {
"key": "loan_app",
"label": "Loan apps"
},
"entities_named": [
"QuickCash Test"
],
"source": {
"name": "TrustCheck sandbox",
"url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"published_on": "2026-11-12"
},
"meta": {
"mode": "test"
}
}
Licences
/licences
Search licence registers
Entries from Ghana's public licence registers (Bank of Ghana, SEC, NIC, Gaming Commission and others) and their public warning lists. status is "licensed" or "warning". Send q or regulator.
| Parameter | In | Type | Description |
|---|---|---|---|
q |
query | string | Company name, 2 to 120 characters. Legal suffixes (Ltd, PLC) are ignored. |
regulator |
query | string | Only this regulator's registers. One of: bog, sec, nic, gaming, csa, labour, gtec, nca |
status |
query | string | Only licensed entries, or only warnings. One of: licensed, warning |
page |
query | integer | Page number, from 1. Default 1. |
per_page |
query | integer | Items per page, 1 to 100. Default 20. |
curl "https://trustcheckapp.com/api/v1/licences?q=microfinance" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/licences?q=microfinance", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/licences?q=microfinance",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/licences?q=microfinance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": [
{
"object": "licence",
"id": 801,
"slug": "test-microfinance",
"name": "Test Microfinance Ltd",
"aliases": [],
"status": "licensed",
"regulator": {
"key": "bog",
"name": "Bank of Ghana",
"short": "BoG"
},
"register": "Microfinance institutions",
"licence_type": "Microfinance company",
"category": "finance",
"note": null,
"source": {
"title": "TrustCheck sandbox",
"url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"as_of": "2026-10-31",
"checked_at": "2026-11-14",
"profile_url": "https://trustcheckapp.com/developers/docs#sandbox"
}
],
"meta": {
"mode": "test",
"pagination": {
"page": 1,
"per_page": 20,
"total": 1,
"total_pages": 1
}
},
"links": {
"self": "https://trustcheckapp.com/api/v1/licences?page=1",
"first": "https://trustcheckapp.com/api/v1/licences?page=1",
"prev": null,
"next": null,
"last": "https://trustcheckapp.com/api/v1/licences?page=1"
}
}
/licences/{slug}
Get a licence holder
Every register entry for one company (a firm can hold several licences, or appear on a warning list), with licensed and warning flags.
| Parameter | In | Type | Description |
|---|---|---|---|
slug required |
path | string | The slug from a licence entry. |
curl "https://trustcheckapp.com/api/v1/licences/test-microfinance" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/licences/test-microfinance", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/licences/test-microfinance",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/licences/test-microfinance");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "licence_holder",
"slug": "test-microfinance",
"name": "Test Microfinance Ltd",
"licensed": true,
"warning": false,
"entries": [
{
"object": "licence",
"id": 801,
"slug": "test-microfinance",
"name": "Test Microfinance Ltd",
"aliases": [],
"status": "licensed",
"regulator": {
"key": "bog",
"name": "Bank of Ghana",
"short": "BoG"
},
"register": "Microfinance institutions",
"licence_type": "Microfinance company",
"category": "finance",
"note": null,
"source": {
"title": "TrustCheck sandbox",
"url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"as_of": "2026-10-31",
"checked_at": "2026-11-14",
"profile_url": "https://trustcheckapp.com/developers/docs#sandbox"
}
],
"profile_url": "https://trustcheckapp.com/developers/docs#sandbox"
},
"meta": {
"mode": "test"
}
}
Account
/me
Get the current API key
Which key you are using: its mode (live or test), plan and rate limits. Useful to test your setup.
curl "https://trustcheckapp.com/api/v1/me" \
-H "Authorization: Bearer tc_test_YOUR_KEY"
const res = await fetch("https://trustcheckapp.com/api/v1/me", {
headers: { Authorization: "Bearer " + process.env.TRUSTCHECK_KEY },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data } = await res.json();
console.log(data);
import os, requests
res = requests.get(
"https://trustcheckapp.com/api/v1/me",
headers={"Authorization": f"Bearer {os.environ['TRUSTCHECK_KEY']}"},
timeout=10,
)
res.raise_for_status()
print(res.json()["data"])
$ch = curl_init("https://trustcheckapp.com/api/v1/me");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('TRUSTCHECK_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
print_r($body['data']);
Example response (sandbox)
{
"data": {
"object": "api_key",
"name": "My shop integration",
"prefix": "tc_test_4f9a",
"mode": "test",
"plan": "free",
"rate_limit": {
"per_minute": 60,
"per_day": 2000,
"used_today": 12
},
"created_at": "2026-11-15T08:00:00Z",
"last_used_at": "2026-11-15T09:12:44Z"
},
"meta": {
"mode": "test"
}
}
Legacy endpoints
GET /score/{identifier} and GET /search?q= from before v1.0 still work and also accept ?api_key=. They answer with a Deprecation header. Use GET /businesses and GET /businesses/{business} instead.
Support
Questions, higher limits or a bug: contact us. Include the request_id from the response.
Data use: TrustCheck data comes from real customers, official registers and regulator notices. Do not present a business as a scam because of a check result alone; link to the check_url so people can read the reports. See the terms of service.