Docs

Check one identifier

Preview· P9
POST
/checks

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.

Authorization

bearerAuth checks:read
headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs 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 partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs 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

Header Parameters

Origin?string

Sent by browsers. A Check API key can't be used from a browser: a request with it is refused (403).

Request Body

application/json
  1. body
value*string

One phone number, MoMo number, @handle, website or merchant name. Never a list.

Length2 <= length <= 200
kind?string

Say which, when a value could be more than one (shop.gh is a website or a handle).

Value in"phone""handle""website""merchant"
momo_name?string

The name the customer's wallet showed before they confirmed. Compared here and never kept.

Lengthlength <= 120

Response Body

The answer.

application/json
  1. 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*string

The call's ID (chk_…): quote it to Agoo about this call.

object*"check"
Value in"check"
kind*string
Value in"phone""handle""website""merchant"
known*boolean
message?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?string

When momo_name was sent and the value is an official MoMo: how the name compares. A lookalike is never a match.

Value in"match""lookalike""different"
checked_at*string
Formatdate-time
answer_version*string
method_url*string

How answers are worked out.

Formaturi
livemode*boolean
curl -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}