Your Check API usage
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.
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
month?stringThe month, as YYYY-MM; this month when left out.
^[0-9]{4}-[0-9]{2}$Origin?stringSent by browsers. A Check API key can't be used from a browser: a request with it is refused (403).
The month's usage.
application/json- response
object*"check_usage""check_usage"month*stringlag_seconds*integerCounts lag the calls by up to a minute.
days*array<>curl -X GET 'https://api.agoohq.com/v1/checks/usage'{ "object": "check_usage", "month": "string", "lag_seconds": 0, "days": [ { "day": "2019-08-24", "livemode": true, "calls": 0, "billed": 0, "outcomes": { "property1": 0, "property2": 0 } } ]}Check one identifier POST
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`.
The Check API's test values GET
The synthetic identifiers a test key answers, one for every outcome, with their fixed answers. Use them to build and test your integration; a test key refuses any other value. No key is needed.