An online_reputation check searches public web sources for material concerning a company and
returns a written analysis with the sources it drew on.
It targets companies only, is created with is_internal set to true, and resolves
asynchronously.
Product documentation: Online reputation.
Create an online reputation check
POST /v1/checks/online_reputation — the path segment uses an underscore. See
Create an online reputation check.
curl -X POST https://api.dotfile.com/v1/checks/online_reputation \
-H "X-DOTFILE-API-KEY: $DOTFILE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"company_id": "01234567-89ab-cdef-0123-456789abcdef"}'| Field | Type | Required | Description |
|---|---|---|---|
company_id | uuid | yes | the company to analyse |
company_id is the only field the endpoint accepts. This check type exposes no settings object;
the analysis prompt is configured once on the workspace and applies to every check.
400 is returned when the workspace check limit is reached.
Status
Creation returns status processing with an empty report. The search and analysis run afterwards,
and the check then resolves without further calls:
| Analysis outcome | Resulting status |
|---|---|
| low or moderate risk | approved |
| high or prohibited risk | need_review |
| inconclusive, or no reading produced | need_review |
The risk reading itself is not exposed over the API; only the resulting status and the report
are. need_review indicates the analysis did not resolve on its own.
Because resolution is asynchronous, subscribe to the Check.Approved and Check.ReviewNeeded
webhook events rather than polling. Both carry the complete check object.
Response
| Field | Description |
|---|---|
data.result | approved, rejected or error |
data.information.report | the full written analysis |
data.information.summary | condensed form of the report |
data.information.sources | array of the pages analysed, each with title and url |
data.information.company | the company as searched: name, commercial_name, country, registration_number, website_url |
data.review | comment, reviewed_at, reviewer_type, user |
data.information.sources is what makes the report auditable and is worth persisting alongside
report.
Two objects present on other check types are not exposed here: settings, including the prompt
that produced the report, and vendor.
subtype is always null on an online_reputation check.
Review
PATCH /v1/checks/online_reputation/{id}/review —
Review an online reputation check.
curl -X PATCH https://api.dotfile.com/v1/checks/online_reputation/$CHECK_ID/review \
-H "X-DOTFILE-API-KEY: $DOTFILE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action": "approve", "comment": "Negative results are consumer complaints, not fraud signals"}'| Field | Type | Required | Description |
|---|---|---|---|
action | approve | reject | yes | the decision |
comment | string | no | recorded on data.review |
override | boolean | no | permits changing a check already in approved or rejected |
data.review.reviewer_type is set to api.
Retrieval
Retrieve an online reputation check returns the full object, data
included.
Retrieve a case and List checks return the check envelope
only — id, company_id, type, status, subtype, timestamps — without the report.
Related
- The Check object — the shared envelope, statuses and review mechanics
- Company data — the registry record for the same company
- Templates — creating the check from a verification policy rather than per call