One endpoint. One response. That's the whole API.

Subtext's API is designed to do one thing well: take a merchant URL and return a structured risk report. No complex setup, no multi-step flows, no configuration required to start.

Request
1import Subtext from "@subtext/node";
2 
3// merchant: ScreenParams
4const client = new Subtext({
5 apiKey: process.env.SUBTEXT_API_KEY,
6 version: "2025-01",
7});
8 
9const result: ScreenResult = await client.screen({
10 merchantId: "mer_8f2k9d",
11 business: {
12 legalName: "Crestwood Distribution LLC",
13 dba: "Crestwood Supply Co.",
14 registrationNumber: "EIN-82-4917263",
15 jurisdiction: "US-DE",
16 website: "https://crestwoodsupply.com",
17 phone: "+1 302 555 0174",
18 mcc: "5065",
19 },
20 options: {
21 depth: "full",
22 include: ["blocklist", "social", "reviews", "industry", "location"],
23 webhookUrl: "https://yourplatform.com/webhooks/subtext",
24 },
25});
200 OK17,400msPOST /v1/screen

From API key to first report in five minutes.

Standard Keys

Create a key with full API access, enabling extensive interaction with your account.

Publishable Key

test

pk_test_j8JIEcwAyd8uWD7NA4SDWISr5AfDKdW12e3D2dqoWA

Secret Key

live

sk_live_••••••••••Rd

Get your API key. Sign up for a Subtext account. Your API key is on the dashboard. No approval process, no sales call required for sandbox access.

REQUEST

POST /v1/merchant/screen

{

"url": "https://crestwoodsupply.com",

"rules": "default",

"jurisdiction": "US-DE",

"phone": "+1 302 555 0174",

"registration_number": "EIN-82-4917263",

"duration_ms": 17400,

{

Make your first request: Pass a merchant URL & your preferred rule set. Subtext handles the rest, pulling from multiple sources in a single call.

{

"screening_id": "scr_01HXKJ9M4P",

"status": "complete",

"completed_at": "2025-04-12T09:14:03Z",

"duration_ms": 17400,

"decision": {

"recommendation": "approve",

"risk_level": "low",

"score": 82,

"confidence": 0.94

}

Read the response: A structured JSON report with business verification, industry classification, risk level, & recommendation in under 30 seconds.

Everything your team needs to make a decision. Nothing they don't.

The response is designed to be acted on, not analyzed. Each field tells your system exactly what it needs to know — and nothing else. Pipe it directly into your decisioning logic, store it for audit, or surface it to your risk team.

FieldTypeDescriptionExample
merchantstringVerified business nameCrestwood Distribution LLC
urlstringAnalyzed URLhttps://crestwoodsupply.com
risk_levelenumlow · medium · high · criticallow
verifiedbooleanWhether the business existence is confirmedtrue
industrystringAI-classified industry based on web contentwholesale_electronics
signals.websitestringWebsite operational status and agereachable · ssl_valid · 1847 days
signals.reviewsstringReview sentiment summary and count4.3/5 · 214 reviews · positive
signals.socialstringSocial profile consistency assessmentlinkedin · instagram · consistent
signals.locationstringLocation verification resultverified · coordinates_match
signals.blockliststringBlocklist screening resultclear · OFAC · EU · UN
recommendationenumauto_approve · manual_review · rejectauto_approve
evidencearrayLinks to sources analyzedhttps://crestwoodsupply.com, https://reviews.com/crestwood
analyzed_instringProcessing time19.8s

Built for how compliance teams actually work.

Webhook Events

Batch Processing. Submit hundreds of merchants in a single request. Results are delivered as each screening completes — no need to wait for the entire batch.

Webhook Events

Configurable Rules. Define your own risk thresholds, industry allowlists, and auto-decision criteria. Subtext applies your rules to every report so the output matches your compliance policy.

Webhook Events

Webhook Events. Subscribe to screening events and receive alerts when reports are ready, when risk levels change, or when a merchant's profile is updated during monitoring.

Webhook Events

Portal Access. Not everything needs to go through the API. The Subtext portal gives analysts a visual interface for running ad‑hoc screenings and reviewing reports.

SDKs and Integrations

Works with your stack. Not instead of it.

Subtext integrates with your existing onboarding flow, risk engine, or case management system. The API returns standard JSON — build your own integration, or use one of our client libraries.

Python SDKPython
Node JS SDKNode JS
Javascript SDKJavascript
Ruby SDKRuby
cURL