Check one identifier
Checks one phone number, MoMo number, @handle, website or merchant name against what Agoo Reviews knows, before money moves. The answer gives only confirmed records and official warnings, the same for every partner: whether it's a verified official contact of a business (with that business's page), the confirmed reports' count and kinds, consumer alerts for a regulator's action or impersonation, and the businesses a confirmed fake pretends to be. "We have no record of this" never means safe.
One identifier a call: there's no list, prefix, search or watch. A test key (agoo_ck_test_) answers only the
published test values. Every live call is billed, "no record" included; an invalid one isn't. Answers are never
cached. Never refuse anyone a service on an answer alone without a person's review.
Key: a Check API key, agoo_ck_live_ or agoo_ck_test_, with checks:read.
bearerAuth checks:readAuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
agoo_ck_live_ | Check API key, live mode, for a Check API partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As above, answering only the published test values, never billed |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: checks:read
Origin?stringSent by browsers. A Check API key can't be used from a browser: a request with it is refused (403).
application/json- body
value*stringOne phone number, MoMo number, @handle, website or merchant name. Never a list.
2 <= length <= 200kind?stringSay which, when a value could be more than one (shop.gh is a website or a handle).
"phone""handle""website""merchant"momo_name?stringThe name the customer's wallet showed before they confirmed. Compared here and never kept.
length <= 120The answer.
application/json- response
The answer to one check, the same for every partner. known: false means Agoo has no record of it, never that it's safe.
id*stringThe call's ID (chk_…): quote it to Agoo about this call.
object*"check""check"kind*string"phone""handle""website""merchant"known*booleanmessage?string"We have no record of this." when known is false.
official*array<>register?array<unknown>An official business's lines from official registers, as its page shows them.
reports?Confirmed reports only: never a report's words, a reporter, or one not yet confirmed.
warnings*array<>impersonating?array<>The businesses a confirmed fake pretends to be.
momo_name_match?stringWhen momo_name was sent and the value is an official MoMo: how the name compares. A lookalike is never a match.
"match""lookalike""different"checked_at*stringdate-timeanswer_version*stringmethod_url*stringHow answers are worked out.
urilivemode*booleancurl -X POST 'https://api.agoohq.com/v1/checks' \ -H 'Content-Type: application/json' \ -d '{ "value": "string"}'{ "id": "string", "object": "check", "kind": "phone", "known": true, "message": "string", "official": [ { "business": { "name": "string", "page": "http://example.com", "verified": true }, "as": "phone" } ], "register": [ null ], "reports": { "confirmed": 0, "kinds": [ "string" ], "first_month": "string", "latest_month": "string", "dispute_waiting": true }, "warnings": [ { "business": "string", "cause": "regulator_action", "since": "2019-08-24" } ], "impersonating": [ { "name": "string", "page": "http://example.com" } ], "momo_name_match": "match", "checked_at": "2019-08-24T14:15:22Z", "answer_version": "string", "method_url": "http://example.com", "livemode": true}Get a review case GET
Returns one case on your page, within your key's branches. **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.
Your Check API usage GET
Your own calls by day, live and test, how many were billed, and by outcome. The counts lag the calls by up to a minute, and your daily and monthly caps are read from them. **Key:** a Check API key, `agoo_ck_live_` or `agoo_ck_test_`, with `checks:read`.