{ "openapi": "3.0.3", "info": { "title": "PII Redaction, Company Identity and Lead Research API", "version": "2.0.0", "description": "Redact personal data, resolve companies to legal entities, verify badges and research sales leads.", "contact": { "name": "WritersLogic", "url": "https://writerslogic.com/agents" }, "termsOfService": "https://writerslogic.com/terms", "x-category": "business1", "x-long-description": "Data privacy and company intelligence behind one API. Redact personal data from text with a built-in self-check, resolve a name, domain, LEI, VAT number or ticker to one legal entity, verify Open Badges credentials, enrich a lead from its homepage and build a competitor pricing battlecard. Every successful response is signed.\n\nEndpoints: PII Redaction with Self-Check; Company Identity Resolver (LEI, VAT, CIK); Open Badges Credential Verifier; B2B Lead Enrichment and Cold Email Draft; Competitor Pricing Battlecard; Verify a Signed Result.\n\nEvery successful response is signed, and the Verify a Signed Result endpoint checks any of them. Documentation for every endpoint: https://writerslogic.com/agents/", "x-website": "https://writerslogic.com/agents/", "x-public": false, "x-thumbnail": "https://agents.writerslogic.com/logos/identity.png", "x-version-lifecycle": "active" }, "servers": [ { "url": "https://agents.writerslogic.com/api", "description": "Base URL" } ], "components": {}, "paths": { "/v1/redact-text": { "post": { "operationId": "redactText", "summary": "PII Redaction with Self-Check", "description": "`POST /v1/redact-text`\n\nRedacts personal data from text at the level you choose (1 government IDs, 2 adds birth dates, 3 adds addresses and phones, 4 adds names and emails) and rescans its own output to prove it is clean. Checksum-based detectors avoid swallowing ordinary numbers. The response lists category, position and confidence for each redaction and never repeats the original values. Text up to 1,000,000 characters; nothing is stored.\n\n**What you get:** Sending a contract, medical note or support log to a model, a vendor or a court filing without scrubbing it is a breach waiting to happen. This returns the scrubbed text, a count of what was removed by type, and a check that nothing detectable remains.\n\n### Use it for\n\n- Scrub personal data from a contract, medical note or support log before sending it to a model or a vendor.\n- Choose how much to remove, from government identifiers only up to names and email addresses.\n- Get a count of what was removed by type and a second scan that confirms nothing detectable remains.\n\n### Details and limits\n\nRedacts personal data from text at the level you choose and proves the output is clean by scanning it again. Pick a level: 1 government identifiers (SSN, ITIN, EIN, UK NINO, Canadian SIN, driver's license, passport), 2 adds dates of birth, 3 adds street addresses and phone numbers, 4 adds person names and email addresses. Then switch single categories on or off with include and exclude, or name the exact set with categories; extras are credit cards, IBANs, routing and account numbers, IP addresses, URLs, every date, and organizations. minDigitRun redacts any run of that many digits, terms redacts words you list (business names, project names), and keep protects strings such as your own email address. Detectors use checksums and structure rules (Luhn, ABA, mod-97, SSN and EIN rules) so ordinary numbers are not swallowed, and every later mention of a redacted value is redacted too. Replacements are labels like [REDACTED:SSN], one generic marker, numbered tokens like [PERSON_2] that stay consistent, or labels that keep the last four characters. The response lists category, position and confidence for each redaction and never repeats the original values. The engine rescans its own output and returns an error (payment released) rather than a result that still contains a detected value. Names and organizations are heuristic; set useModel to add a model pass for names, organizations and addresses, which sends the text to the configured language-model provider. Text only, up to 1,000,000 characters (the request body may be up to 4 MB of UTF-8); nothing is stored and no digest of the input is returned.\n\n### Request fields\n\nSend these as a JSON body.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `text` | string | yes | The document text to redact (plain text, Markdown, CSV, JSON or HTML source). |\n| `level` | integer | no | Cumulative preset, default 1. 1: government identifiers (SSN, ITIN, EIN, UK NINO, Canadian SIN, driver's license, passport); 2: level 1 plus dates of birth; 3: level 2 plus street addresses and phone numbers; 4: level 3 plus person names and email addresses. |\n| `categories` | array of string | no | Exact set of categories to redact; replaces the level preset when given. |\n| `include` | array of string | no | Categories to add to the level preset. |\n| `exclude` | array of string | no | Categories to remove from the level preset. |\n| `minDigitRun` | integer | no | Also redact every run of at least this many digits (spaces, dots and hyphens between digits count as part of the run). This is the number of digits, not the numeric value. |\n| `terms` | array of string | no | Words or phrases to redact wherever they appear (business names, project names, people you already know). Case-insensitive. |\n| `keep` | array of string | no | Strings that must never be redacted, such as your own email address or company name. Case-insensitive, whole match. |\n| `style` | enum | no | label (default): [REDACTED:SSN]. generic: [REDACTED]. numbered: [PERSON_1], same value same number. last4: [REDACTED:SSN:*6789] for numeric identifiers; this discloses the last four characters. |\n| `useModel` | boolean | no | Add a language-model pass for names, organizations and addresses (when those categories are on). Sends the text, up to 60000 characters, to the configured model provider. Default false. |\n\n### Example request body\n\n```json\n{\n \"text\": \"Patient: Maria Gonzalez, DOB 04/12/1980, SSN 123-45-6789. Reach her at maria.gonzalez@example.org or (555) 010-0199. Maria Gonzalez was seen at Acme Clinic, Inc.\",\n \"level\": 4,\n \"include\": [\n \"organization\"\n ],\n \"style\": \"label\"\n}\n```\n\n### Request (curl)\n\n```bash\ncurl -X POST \"https://$RAPIDAPI_HOST/v1/redact-text\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-RapidAPI-Key: $RAPIDAPI_KEY\" \\\n -H \"X-RapidAPI-Host: $RAPIDAPI_HOST\" \\\n -d '{\"text\":\"Patient: Maria Gonzalez, DOB 04/12/1980, SSN 123-45-6789. Reach her at maria.gonzalez@example.org or (555) 010-0199. Maria Gonzalez was seen at Acme Clinic, Inc.\",\"level\":4,\"include\":[\"organization\"],\"style\":\"label\"}'\n```\n\n### What comes back\n\nA 200 response is `{ \"data\": ..., \"_provenance\": ... }`. `_provenance` is a signed record of the sources read; the Verify a Signed Result endpoint checks it.\n\nFields of `data`:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `redactedText` | string | Redacted text. |\n| `status` | enum | One of: complete. |\n| `summary` | object | total redactions, byCategory counts and charactersRemoved. |\n| `redactions` | array of object | Redactions, a list of objects. |\n| `verification` | object | passed, residualDetections (rescan of the output), leakedValues (redacted values found again), distinctValues and outputSha256. No digest of the input is returned or signed, because a digest of guessable text would let a recipient recover what was redacted. |\n| `config` | object | The level, final category list, minDigitRun, style and useModel actually applied. |\n| `coverage` | array of object | Coverage, a list of objects. |\n| `limits` | array of string | Limits, a list of strings. |\n| `deterministic` | boolean | True when no model was used. |\n\nExample `data` from a real recorded call (long values shortened):\n\n```json\n{\n \"redactedText\": \"Patient: [REDACTED:PERSON], DOB [REDACTED:DOB], SSN [REDACTED:SSN]. Reach her at [REDACTED:EMAIL] or [REDACTED:PHONE]. [REDACTED:PERSON] was seen at [REDACTE...\",\n \"status\": \"complete\",\n \"summary\": {\n \"total\": 7,\n \"byCategory\": {\n \"person_name\": 2,\n \"date_of_birth\": 1,\n \"ssn\": 1,\n \"email\": 1,\n \"phone\": 1,\n \"organization\": 1\n },\n \"charactersRemoved\": 106\n },\n \"redactions\": [\n {\n \"category\": \"person_name\",\n \"start\": 9,\n \"end\": 23,\n \"length\": 14,\n \"replacement\": \"[REDACTED:PERSON]\",\n \"confidence\": \"context\",\n \"rule\": \"name-after-patient\"\n },\n {\n \"category\": \"date_of_birth\",\n \"start\": 29,\n \"end\": 39,\n \"length\": 10,\n \"replacement\": \"[REDACTED:DOB]\",\n \"confidence\": \"context\",\n \"rule\": \"dob-label\"\n },\n {\n \"category\": \"ssn\",\n \"start\": 45,\n \"end\": 56,\n \"length\": 11,\n \"replacement\": \"[REDACTED:SSN]\",\n \"confidence\": \"validated\",\n \"rule\": \"ssn-formatted\"\n }\n ],\n \"verification\": {\n \"passed\": true,\n \"residualDetections\": 0,\n \"leakedValues\": 0,\n \"distinctValues\": 6,\n \"outputSha256\": \"12cba160d18d9128c795727caa3751a2729b254e992349f815e8fc238f5abe34\"\n },\n \"config\": {\n \"level\": 4,\n \"categories\": [\n \"address\",\n \"date_of_birth\",\n \"drivers_license\"\n ],\n \"minDigitRun\": null,\n \"terms\": 0,\n \"keep\": 0,\n \"style\": \"label\",\n \"useModel\": false\n },\n \"coverage\": [\n {\n \"category\": \"address\",\n \"count\": 0,\n \"method\": \"pattern\",\n \"limits\": \"US street, PO box, city-state-ZIP and UK postcode layouts. Other countries' addresses are not covered; use useModel for those.\"\n },\n {\n \"category\": \"date_of_birth\",\n \"count\": 1,\n \"method\": \"label-keyed\",\n \"limits\": \"Dates within a few characters after DOB, date of birth, born. An unlabeled birth date is only caught with the date category.\"\n },\n {\n \"category\": \"drivers_license\",\n \"count\": 0,\n \"method\": \"label-keyed\",\n \"limits\": \"Only values that follow a driver's-license label. State formats overlap other numbers, so unlabeled licence numbers are not found.\"\n }\n ],\n \"limits\": [\n \"Detection finds what its rules and your terms describe; it cannot prove a document contains no other personal data. Review the output before publishing.\",\n \"Plain text only. For PDF, DOCX or images, extract the text, redact it, and rebuild the file; a visual overlay does not remove text from the file.\",\n \"No model was used and the text left this service nowhere.\"\n ],\n \"deterministic\": true\n}\n```\n\n### HTTP response status codes\n\n- 200: success; the body is `{ \"data\": ..., \"_provenance\": ... }`.\n- 400: the request failed validation; `error` names the field and `code` is `invalid_request`.\n- 401: the RapidAPI key or subscription is missing or not valid for this API.\n- 429: the plan's rate limit was reached.\n- 5xx: the call failed on our side or at an upstream source; retry it.\n\nFull field-by-field documentation: https://writerslogic.com/agents/redact-text/\nMachine-readable input and result schemas: https://writerslogic.com/agents/redact-text.json", "x-sample-url": "https://agents.writerslogic.com/api/v1/samples/redact-text", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 1000000, "description": "The document text to redact (plain text, Markdown, CSV, JSON or HTML source)." }, "level": { "type": "integer", "minimum": 1, "maximum": 4, "description": "Cumulative preset, default 1. 1: government identifiers (SSN, ITIN, EIN, UK NINO, Canadian SIN, driver's license, passport); 2: level 1 plus dates of birth; 3: level 2 plus street addresses and phone numbers; 4: level 3 plus person names and email addresses." }, "categories": { "type": "array", "maxItems": 20, "items": { "type": "string", "enum": [ "ssn", "itin", "ein", "nino", "sin", "drivers_license", "passport", "date_of_birth", "address", "phone", "person_name", "email", "credit_card", "iban", "routing_number", "account_number", "ip_address", "url", "date", "organization" ] }, "description": "Exact set of categories to redact; replaces the level preset when given." }, "include": { "type": "array", "maxItems": 20, "items": { "type": "string", "enum": [ "ssn", "itin", "ein", "nino", "sin", "drivers_license", "passport", "date_of_birth", "address", "phone", "person_name", "email", "credit_card", "iban", "routing_number", "account_number", "ip_address", "url", "date", "organization" ] }, "description": "Categories to add to the level preset." }, "exclude": { "type": "array", "maxItems": 20, "items": { "type": "string", "enum": [ "ssn", "itin", "ein", "nino", "sin", "drivers_license", "passport", "date_of_birth", "address", "phone", "person_name", "email", "credit_card", "iban", "routing_number", "account_number", "ip_address", "url", "date", "organization" ] }, "description": "Categories to remove from the level preset." }, "minDigitRun": { "type": "integer", "minimum": 4, "maximum": 40, "description": "Also redact every run of at least this many digits (spaces, dots and hyphens between digits count as part of the run). This is the number of digits, not the numeric value." }, "terms": { "type": "array", "maxItems": 200, "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Words or phrases to redact wherever they appear (business names, project names, people you already know). Case-insensitive." }, "keep": { "type": "array", "maxItems": 200, "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Strings that must never be redacted, such as your own email address or company name. Case-insensitive, whole match." }, "style": { "type": "string", "enum": [ "label", "generic", "numbered", "last4" ], "description": "label (default): [REDACTED:SSN]. generic: [REDACTED]. numbered: [PERSON_1], same value same number. last4: [REDACTED:SSN:*6789] for numeric identifiers; this discloses the last four characters." }, "useModel": { "type": "boolean", "description": "Add a language-model pass for names, organizations and addresses (when those categories are on). Sends the text, up to 60000 characters, to the configured model provider. Default false." } }, "description": "Input payload for Selective PII redaction with a self-check. Required fields: `text`. Optional fields: `level`, `categories`, `include`, `exclude`, `minDigitRun`, `terms`, `keep`, `style`, `useModel`.", "externalDocs": { "url": "https://writerslogic.com/agents/redact-text.json", "description": "Machine-readable record for Selective PII redaction with a self-check: the full input and result JSON Schemas, an example payload and the OpenAPI operation." } }, "examples": { "default": { "summary": "Example request for Selective PII redaction with a self-check", "description": "A complete valid request body for PII Redaction with Self-Check.", "value": { "text": "Patient: Maria Gonzalez, DOB 04/12/1980, SSN 123-45-6789. Reach her at maria.gonzalez@example.org or (555) 010-0199. Maria Gonzalez was seen at Acme Clinic, Inc.", "level": 4, "include": [ "organization" ], "style": "label" } }, "Names and emails too (level 4)": { "summary": "Names and emails too (level 4)", "value": { "text": "Contact Jane Doe at jane@example.com or 415-555-0100. SSN 123-45-6789.", "level": 4 } } } } }, "description": "JSON request body for Selective PII redaction with a self-check. Required fields: `text`. Optional fields: `level`, `categories`, `include`, `exclude`, `minDigitRun`, `terms`, `keep`, `style`, `useModel`. Unknown fields are rejected with a 400." }, "responses": { "200": { "description": "Success. `data` holds the answer and `_provenance` holds the signed credential for it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "redactedText": { "type": "string", "description": "Redacted text." }, "status": { "type": "string", "enum": [ "complete" ], "description": "One of: complete." }, "summary": { "type": "object", "description": "total redactions, byCategory counts and charactersRemoved." }, "redactions": { "type": "array", "items": { "type": "object", "description": "category, start and end offsets into the ORIGINAL text, length, the replacement written, confidence (validated, pattern, context, heuristic, model) and the rule. The original value is never included." }, "description": "Redactions, a list of objects." }, "verification": { "type": "object", "description": "passed, residualDetections (rescan of the output), leakedValues (redacted values found again), distinctValues and outputSha256. No digest of the input is returned or signed, because a digest of guessable text would let a recipient recover what was redacted." }, "config": { "type": "object", "description": "The level, final category list, minDigitRun, style and useModel actually applied." }, "coverage": { "type": "array", "items": { "type": "object", "description": "For each enabled category: count redacted, method and what it can and cannot find." }, "description": "Coverage, a list of objects." }, "limits": { "type": "array", "items": { "type": "string" }, "description": "Limits, a list of strings." }, "deterministic": { "type": "boolean", "description": "True when no model was used." } }, "description": "Data, an object." }, "_provenance": { "type": "object", "description": "C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance" } }, "required": [ "data", "_provenance" ] }, "example": { "data": { "redactedText": "Patient: [REDACTED:PERSON], DOB [REDACTED:DOB], SSN [REDACTED:SSN]. Reach her at [REDACTED:EMAIL] or [REDACTED:PHONE]. [REDACTED:PERSON] was seen at [REDACTED:ORG]", "status": "complete", "summary": { "total": 7, "byCategory": { "person_name": 2, "date_of_birth": 1, "ssn": 1, "email": 1, "phone": 1, "organization": 1 }, "charactersRemoved": 106 }, "redactions": [ { "category": "person_name", "start": 9, "end": 23, "length": 14, "replacement": "[REDACTED:PERSON]", "confidence": "context", "rule": "name-after-patient" }, { "category": "date_of_birth", "start": 29, "end": 39, "length": 10, "replacement": "[REDACTED:DOB]", "confidence": "context", "rule": "dob-label" }, { "category": "ssn", "start": 45, "end": 56, "length": 11, "replacement": "[REDACTED:SSN]", "confidence": "validated", "rule": "ssn-formatted" } ], "verification": { "passed": true, "residualDetections": 0, "leakedValues": 0, "distinctValues": 6, "outputSha256": "12cba160d18d9128c795727caa3751a2729b254e992349f815e8fc238f5abe34" }, "config": { "level": 4, "categories": [ "address", "date_of_birth", "drivers_license" ], "minDigitRun": null, "terms": 0, "keep": 0, "style": "label", "useModel": false }, "coverage": [ { "category": "address", "count": 0, "method": "pattern", "limits": "US street, PO box, city-state-ZIP and UK postcode layouts. Other countries' addresses are not covered; use useModel for those." }, { "category": "date_of_birth", "count": 1, "method": "label-keyed", "limits": "Dates within a few characters after DOB, date of birth, born. An unlabeled birth date is only caught with the date category." }, { "category": "drivers_license", "count": 0, "method": "label-keyed", "limits": "Only values that follow a driver's-license label. State formats overlap other numbers, so unlabeled licence numbers are not found." } ], "limits": [ "Detection finds what its rules and your terms describe; it cannot prove a document contains no other personal data. Review the output before publishing.", "Plain text only. For PDF, DOCX or images, extract the text, redact it, and rebuild the file; a visual overlay does not remove text from the file.", "No model was used and the text left this service nowhere." ], "deterministic": true }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:6d49338e-ae53-4d3e-a88d-ca0b15bd9ad7", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Selective PII redaction with a self-check", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T01:30:19.059Z", "softwareAgent": { "name": "writerslogic-agent-hub/redact-text", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/algorithmicMedia", "parameters": { "endpoint": "POST /api/v1/redact-text" } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "7581017ccdbe623929ede242a7835ca05dcb1f86664e7a705cab10704263cd88", "name": "jcs-canonical-json(data)" } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:3ab7871d-4d60-471c-9916-0e47392f4cc5", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T01:30:19.059Z", "credentialSubject": { "id": "urn:sha256:7581017ccdbe623929ede242a7835ca05dcb1f86664e7a705cab10704263cd88", "agent": "redact-text", "endpoint": "POST /api/v1/redact-text", "outputDigest": { "alg": "sha256", "value": "7581017ccdbe623929ede242a7835ca05dcb1f86664e7a705cab10704263cd88", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "a1c6c1166a851f51c90a29a269a49ea74c7d30082c2e4d0a21d66395aa6ad5b8", "canonicalization": "JCS" }, "ingredients": [], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T01:30:19.059Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z448Q1T8kxCue6V4cp9yCAkfh7uC9ZFTDuM8QSqsrtvdZeKqFd5AZ2d3kTcTEkZRbvfVcUEuVjctU4gkBPVJqaznE" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:b36b8db8fc8d6413133e9172920c7db83d23af54ffa5d9cec26ff10294dcde60", "signature": "0xd2b826c8e6624e1bbd1aa58cafa423ae059132eb3a183680f80c609042c8620b601022263e9169f618f948edad97a42bac74122f2d305623884a93a331bc94b11b" } } } } } }, "400": { "description": "Invalid request. The `error` field names the offending field and `code` is `invalid_request`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "401": { "description": "Missing or invalid RapidAPI key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "402": { "description": "Payment required. The request did not arrive through RapidAPI.", "content": { "application/json": { "schema": { "type": "object", "description": "x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)", "properties": { "x402Version": { "type": "integer" }, "error": { "type": "string" }, "code": { "type": "string" }, "resource": { "type": "object" }, "accepts": { "type": "array", "items": { "type": "object" } }, "extensions": { "type": "object" } } } } } }, "502": { "description": "A source or model this endpoint depends on failed. Retry later; the body carries an `error` message and a `code`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } } }, "externalDocs": { "url": "https://writerslogic.com/agents/redact-text/", "description": "Documentation for Selective PII redaction with a self-check: what it does, every input and result field, an example call and the response shape. A free signed sample response is linked from the page." }, "x-tests": [ { "name": "redact-text: unknown field is rejected", "method": "POST", "path": "/v1/redact-text", "body": { "nonsense": true }, "assert": { "status": 400, "json": { "code": "invalid_request" }, "maxMs": 10000 } }, { "name": "redact-text: example returns a signed result", "method": "POST", "path": "/v1/redact-text", "body": { "text": "Patient: Maria Gonzalez, DOB 04/12/1980, SSN 123-45-6789. Reach her at maria.gonzalez@example.org or (555) 010-0199. Maria Gonzalez was seen at Acme Clinic, Inc.", "level": 4, "include": [ "organization" ], "style": "label" }, "assert": { "status": 200, "jsonPathsExist": [ "data", "_provenance.credential" ], "jsonSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "redactedText": { "type": "string" }, "status": { "type": "string", "enum": [ "complete" ] }, "summary": { "type": "object" }, "redactions": { "type": "array", "items": { "type": "object" } }, "verification": { "type": "object" }, "config": { "type": "object" }, "coverage": { "type": "array", "items": { "type": "object" } }, "limits": { "type": "array", "items": { "type": "string" } }, "deterministic": { "type": "boolean" } } }, "_provenance": { "type": "object" } }, "required": [ "data", "_provenance" ] }, "maxMs": 120000 } } ] } }, "/v1/company-identity": { "post": { "operationId": "companyIdentity", "summary": "Company Identity Resolver (LEI, VAT, CIK)", "description": "`POST /v1/company-identity`\n\nResolves a company name, domain, LEI, EU VAT number, SEC CIK or ticker to one legal entity using GLEIF, the SEC ticker table and EU VIES. Returns legal name, addresses, jurisdiction, registry ID and parents, or status ambiguous with ranked candidates instead of guessing. For KYC, vendor onboarding and CRM de-duplication. It does not scrape the domain.\n\n### Use it for\n\n- Resolve a company name, domain, LEI, VAT number, CIK or ticker to one legal entity.\n- Look up legal name, jurisdiction, registry id and parent entities from GLEIF, SEC and VIES in one call.\n- Get ranked candidates when a name is ambiguous instead of a wrong guess.\n\n### Details and limits\n\nResolves a company name, web domain, LEI, EU VAT number, SEC CIK or stock ticker to one legal entity using official free registries in a single call: GLEIF (legal name, other names, addresses, jurisdiction, registry id, direct and ultimate parent), the SEC ticker table (CIK, ticker), the EU VIES VAT service, and Companies House officers when the operator has configured a key. Deterministic matching with explicit ambiguity: when no single candidate clearly leads, it returns status \"ambiguous\" with ranked candidates instead of guessing. For KYC, vendor onboarding and CRM de-duplication by agents. It does NOT fetch or scrape the domain, does not cover companies without an LEI, does not return beneficial owners or financials, and uses no model.\n\n### Request fields\n\nSend these as a JSON body.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `name` | string | no | Company name, with or without legal form. |\n| `domain` | string | no | Company web domain; only used to guess a name and to prefer matching candidates. It is never fetched. |\n| `lei` | string | no | 20-character LEI; check digits are validated (ISO 17442). |\n| `vat` | object | no | VAT, an object. |\n| `cik` | integer | no | SEC Central Index Key. |\n| `ticker` | string | no | Stock ticker, matched case-insensitively against the SEC table. |\n| `country` | string | no | ISO 3166-1 alpha-2 hint; raises the score of candidates registered in that country. |\n| `include_parents` | boolean | no | Look up GLEIF direct and ultimate parents. Default true. |\n| `max_candidates` | integer | no | How many ranked candidates to return. Default 5. |\n\n### Example request body\n\n```json\n{\n \"name\": \"Apple Inc\",\n \"country\": \"US\"\n}\n```\n\n### Request (curl)\n\n```bash\ncurl -X POST \"https://$RAPIDAPI_HOST/v1/company-identity\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-RapidAPI-Key: $RAPIDAPI_KEY\" \\\n -H \"X-RapidAPI-Host: $RAPIDAPI_HOST\" \\\n -d '{\"name\":\"Apple Inc\",\"country\":\"US\"}'\n```\n\n### What comes back\n\nA 200 response is `{ \"data\": ..., \"_provenance\": ... }`. `_provenance` is a signed record of the sources read; the Verify a Signed Result endpoint checks it.\n\nFields of `data`:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `query` | object | The input as interpreted, with defaults applied. |\n| `status` | enum | resolved: one candidate scored >= 0.85 and leads the runner-up by >= 0.15 (or an LEI was given). ambiguous: ranked candidates, no best. |\n| `best` | object, nullable | Best, an object. |\n| `candidates` | array of object | Candidates, a list of objects. |\n| `sources` | array of object | Sources, a list of objects. |\n| `notes` | array of string | Degraded or missing sources. |\n| `limits` | object | Limits, an object. |\n\nExample `data` from a real recorded call (long values shortened):\n\n```json\n{\n \"query\": {\n \"name\": \"Apple Inc\",\n \"country\": \"US\",\n \"include_parents\": true,\n \"max_candidates\": 5\n },\n \"status\": \"resolved\",\n \"best\": {\n \"lei\": \"HWUPKR0MPOU8FGXBT394\",\n \"legal_name\": \"Apple Inc.\",\n \"other_names\": [\n \"Apple Computer, Inc.\"\n ],\n \"entity_status\": \"ACTIVE\",\n \"registration_status\": \"ISSUED\",\n \"jurisdiction\": \"US-CA\",\n \"legal_form_elf\": \"H1UM\",\n \"registry\": {\n \"authority_id\": \"RA000598\",\n \"registered_as\": \"806592\"\n },\n \"legal_address\": {\n \"lines\": [\n \"C/O C T Corporation System\",\n \"330 N. Brand Blvd\",\n \"Suite 700\"\n ],\n \"city\": \"Glendale\",\n \"region\": \"US-CA\",\n \"country\": \"US\",\n \"postal_code\": \"91203\"\n },\n \"headquarters_address\": {\n \"lines\": [\n \"One Apple Park Way\"\n ],\n \"city\": \"Cupertino\",\n \"region\": \"US-CA\",\n \"country\": \"US\",\n \"postal_code\": \"95014\"\n },\n \"sec\": {\n \"cik\": \"0000320193\",\n \"ticker\": \"AAPL\",\n \"title\": \"Apple Inc.\"\n },\n \"vat\": null,\n \"uk\": null,\n \"parents\": {\n \"direct\": null,\n \"ultimate\": null,\n \"exception\": \"direct: NATURAL_PERSONS; ultimate: NATURAL_PERSONS\"\n }\n },\n \"candidates\": [\n {\n \"lei\": \"HWUPKR0MPOU8FGXBT394\",\n \"legal_name\": \"Apple Inc.\",\n \"jurisdiction\": \"US-CA\",\n \"entity_status\": \"ACTIVE\",\n \"score\": 1\n },\n {\n \"lei\": \"254900KZR24L5GN8TE52\",\n \"legal_name\": \"Apple Ford, Inc.\",\n \"jurisdiction\": \"US-DE\",\n \"entity_status\": \"ACTIVE\",\n \"score\": 0.816667\n },\n {\n \"lei\": \"5493005L9LZDI71S5Y95\",\n \"legal_name\": \"Apple Gold, Inc.\",\n \"jurisdiction\": \"US-NC\",\n \"entity_status\": \"ACTIVE\",\n \"score\": 0.816667\n }\n ],\n \"sources\": [\n {\n \"url\": \"https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple+Incorporated&page%5Bsize%5D=25\",\n \"sha256\": \"30e5cb7a678384e308d23658b96c00e643ec776d767db8e9a5aa74ac608bf5a7\"\n },\n {\n \"url\": \"https://api.gleif.org/api/v1/lei-records?filter%5Bfulltext%5D=Apple+Inc&page%5Bsize%5D=25\",\n \"sha256\": \"cd1eaeae1e736acf231d531ffbf289052a5507757b679da0dd31c6184db4a27e\"\n },\n {\n \"url\": \"https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple&page%5Bsize%5D=25\",\n \"sha256\": \"2c4ad26d5469e398d075690b53aa79261f4883a6730d9ce8a93fa65d6f016b80\"\n }\n ],\n \"notes\": [],\n \"limits\": {\n \"note\": \"GLEIF covers entities with an LEI only; SEC table covers listed US registrants; VIES only EU VAT; officers only from Companies House\"\n }\n}\n```\n\n### HTTP response status codes\n\n- 200: success; the body is `{ \"data\": ..., \"_provenance\": ... }`.\n- 400: the request failed validation; `error` names the field and `code` is `invalid_request`.\n- 401: the RapidAPI key or subscription is missing or not valid for this API.\n- 429: the plan's rate limit was reached.\n- 5xx: the call failed on our side or at an upstream source; retry it.\n\nFull field-by-field documentation: https://writerslogic.com/agents/company-identity/\nMachine-readable input and result schemas: https://writerslogic.com/agents/company-identity.json", "x-sample-url": "https://agents.writerslogic.com/api/v1/samples/company-identity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 200, "description": "Company name, with or without legal form." }, "domain": { "type": "string", "maxLength": 253, "description": "Company web domain; only used to guess a name and to prefer matching candidates. It is never fetched." }, "lei": { "type": "string", "minLength": 20, "maxLength": 20, "description": "20-character LEI; check digits are validated (ISO 17442)." }, "vat": { "type": "object", "additionalProperties": false, "required": [ "country", "number" ], "properties": { "country": { "type": "string", "enum": [ "AT", "BE", "BG", "CY", "CZ", "DE", "DK", "EE", "EL", "ES", "FI", "FR", "HR", "HU", "IE", "IT", "LT", "LU", "LV", "MT", "NL", "PL", "PT", "RO", "SE", "SI", "SK", "XI" ], "description": "VIES country code (Greece is EL, Northern Ireland XI)." }, "number": { "type": "string", "minLength": 2, "maxLength": 24, "description": "VAT number without the country prefix." } }, "description": "VAT, an object." }, "cik": { "type": "integer", "minimum": 1, "maximum": 9999999999, "description": "SEC Central Index Key." }, "ticker": { "type": "string", "minLength": 1, "maxLength": 10, "description": "Stock ticker, matched case-insensitively against the SEC table." }, "country": { "type": "string", "minLength": 2, "maxLength": 2, "description": "ISO 3166-1 alpha-2 hint; raises the score of candidates registered in that country." }, "include_parents": { "type": "boolean", "default": true, "description": "Look up GLEIF direct and ultimate parents." }, "max_candidates": { "type": "integer", "minimum": 1, "maximum": 10, "default": 5, "description": "How many ranked candidates to return." } }, "description": "Input payload for Company identity: name, domain, LEI, VAT, CIK or ticker to one verified legal entity. Required fields: none. Optional fields: `name`, `domain`, `lei`, `vat`, `cik`, `ticker`, `country`, `include_parents`, `max_candidates`.", "externalDocs": { "url": "https://writerslogic.com/agents/company-identity.json", "description": "Machine-readable record for Company identity: name, domain, LEI, VAT, CIK or ticker to one verified legal entity: the full input and result JSON Schemas, an example payload and the OpenAPI operation." } }, "examples": { "default": { "summary": "Example request for Company identity: name, domain, LEI, VAT, CIK or ticker to one verified legal entity", "description": "A complete valid request body for Company Identity Resolver (LEI, VAT, CIK).", "value": { "name": "Apple Inc", "country": "US" } }, "Look up by ticker": { "summary": "Look up by ticker", "value": { "ticker": "AAPL" } } } } }, "description": "JSON request body for Company identity: name, domain, LEI, VAT, CIK or ticker to one verified legal entity. Required fields: none. Optional fields: `name`, `domain`, `lei`, `vat`, `cik`, `ticker`, `country`, `include_parents`, `max_candidates`. Unknown fields are rejected with a 400." }, "responses": { "200": { "description": "Success. `data` holds the answer and `_provenance` holds the signed credential for it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "object", "description": "The input as interpreted, with defaults applied." }, "status": { "type": "string", "enum": [ "resolved", "ambiguous", "not_found" ], "description": "resolved: one candidate scored >= 0.85 and leads the runner-up by >= 0.15 (or an LEI was given). ambiguous: ranked candidates, no best." }, "best": { "type": "object", "properties": { "lei": { "type": "string", "description": "LEI." }, "legal_name": { "type": "string", "description": "Legal name." }, "other_names": { "type": "array", "items": { "type": "string" }, "description": "Other names, a list of strings." }, "entity_status": { "type": "string", "description": "Entity status." }, "registration_status": { "type": "string", "description": "Registration status." }, "jurisdiction": { "type": "string", "description": "Jurisdiction." }, "legal_form_elf": { "description": "ISO 20275 entity legal form code.", "type": "string", "nullable": true }, "registry": { "type": "object", "properties": { "authority_id": { "type": "string", "nullable": true, "description": "Authority ID." }, "registered_as": { "type": "string", "nullable": true, "description": "Registered as." } }, "description": "Registry, an object." }, "legal_address": { "type": "object", "properties": { "lines": { "type": "array", "items": { "type": "string" }, "description": "Lines, a list of strings." }, "city": { "type": "string", "description": "City." }, "region": { "type": "string", "description": "Region." }, "country": { "type": "string", "description": "Country." }, "postal_code": { "type": "string", "description": "Postal code." } }, "nullable": true, "description": "Legal address, an object." }, "headquarters_address": { "type": "object", "properties": { "lines": { "type": "array", "items": { "type": "string" }, "description": "Lines, a list of strings." }, "city": { "type": "string", "description": "City." }, "region": { "type": "string", "description": "Region." }, "country": { "type": "string", "description": "Country." }, "postal_code": { "type": "string", "description": "Postal code." } }, "nullable": true, "description": "Headquarters address, an object." }, "sec": { "type": "object", "properties": { "cik": { "type": "string", "description": "CIK." }, "ticker": { "type": "string", "description": "Ticker." }, "title": { "type": "string", "description": "Title." } }, "nullable": true, "description": "Sec, an object." }, "vat": { "type": "object", "properties": { "country": { "type": "string", "description": "Country." }, "number": { "type": "string", "description": "Number." }, "valid": { "description": "null when VIES could not answer; see reason.", "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true, "description": "Name." }, "address": { "type": "string", "nullable": true, "description": "Address." }, "checked_at": { "type": "string", "nullable": true, "description": "Checked at." }, "reason": { "type": "string", "nullable": true, "description": "Reason." } }, "nullable": true, "description": "VAT, an object." }, "uk": { "description": "Companies House profile and active officers for UK-registered entities; \"not_configured\" when the operator set no key.", "anyOf": [ { "type": "object", "properties": { "company_number": { "type": "string", "description": "Company number." }, "company_status": { "type": "string", "nullable": true, "description": "Company status." }, "officers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name." }, "role": { "type": "string", "nullable": true, "description": "Role." }, "appointed_on": { "type": "string", "nullable": true, "description": "Appointed on." } } }, "description": "Officers, a list of objects." } } }, { "type": "string", "enum": [ "not_configured" ] } ] }, "parents": { "type": "object", "properties": { "direct": { "type": "object", "properties": { "lei": { "type": "string", "description": "LEI." }, "legal_name": { "type": "string", "description": "Legal name." }, "jurisdiction": { "type": "string", "description": "Jurisdiction." }, "entity_status": { "type": "string", "description": "Entity status." } }, "nullable": true, "description": "Direct, an object." }, "ultimate": { "type": "object", "properties": { "lei": { "type": "string", "description": "LEI." }, "legal_name": { "type": "string", "description": "Legal name." }, "jurisdiction": { "type": "string", "description": "Jurisdiction." }, "entity_status": { "type": "string", "description": "Entity status." } }, "nullable": true, "description": "Ultimate, an object." }, "exception": { "description": "GLEIF reporting-exception reason when a parent is not reported, for example NATURAL_PERSONS.", "type": "string", "nullable": true } }, "nullable": true, "description": "Parents, an object." } }, "nullable": true, "description": "Best, an object." }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "lei": { "type": "string", "description": "LEI." }, "legal_name": { "type": "string", "description": "Legal name." }, "jurisdiction": { "type": "string", "nullable": true, "description": "Jurisdiction." }, "entity_status": { "type": "string", "nullable": true, "description": "Entity status." }, "score": { "type": "number", "description": "Score, a number." } } }, "description": "Candidates, a list of objects." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "URL." }, "sha256": { "type": "string", "description": "SHA-256." } } }, "description": "Sources, a list of objects." }, "notes": { "type": "array", "items": { "type": "string" }, "description": "Degraded or missing sources." }, "limits": { "type": "object", "properties": { "note": { "type": "string", "description": "Note." } }, "description": "Limits, an object." } }, "description": "Data, an object." }, "_provenance": { "type": "object", "description": "C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance" } }, "required": [ "data", "_provenance" ] }, "example": { "data": { "query": { "name": "Apple Inc", "country": "US", "include_parents": true, "max_candidates": 5 }, "status": "resolved", "best": { "lei": "HWUPKR0MPOU8FGXBT394", "legal_name": "Apple Inc.", "other_names": [ "Apple Computer, Inc." ], "entity_status": "ACTIVE", "registration_status": "ISSUED", "jurisdiction": "US-CA", "legal_form_elf": "H1UM", "registry": { "authority_id": "RA000598", "registered_as": "806592" }, "legal_address": { "lines": [ "C/O C T Corporation System", "330 N. Brand Blvd", "Suite 700" ], "city": "Glendale", "region": "US-CA", "country": "US", "postal_code": "91203" }, "headquarters_address": { "lines": [ "One Apple Park Way" ], "city": "Cupertino", "region": "US-CA", "country": "US", "postal_code": "95014" }, "sec": { "cik": "0000320193", "ticker": "AAPL", "title": "Apple Inc." }, "vat": null, "uk": null, "parents": { "direct": null, "ultimate": null, "exception": "direct: NATURAL_PERSONS; ultimate: NATURAL_PERSONS" } }, "candidates": [ { "lei": "HWUPKR0MPOU8FGXBT394", "legal_name": "Apple Inc.", "jurisdiction": "US-CA", "entity_status": "ACTIVE", "score": 1 }, { "lei": "254900KZR24L5GN8TE52", "legal_name": "Apple Ford, Inc.", "jurisdiction": "US-DE", "entity_status": "ACTIVE", "score": 0.816667 }, { "lei": "5493005L9LZDI71S5Y95", "legal_name": "Apple Gold, Inc.", "jurisdiction": "US-NC", "entity_status": "ACTIVE", "score": 0.816667 } ], "sources": [ { "url": "https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple+Incorporated&page%5Bsize%5D=25", "sha256": "30e5cb7a678384e308d23658b96c00e643ec776d767db8e9a5aa74ac608bf5a7" }, { "url": "https://api.gleif.org/api/v1/lei-records?filter%5Bfulltext%5D=Apple+Inc&page%5Bsize%5D=25", "sha256": "cd1eaeae1e736acf231d531ffbf289052a5507757b679da0dd31c6184db4a27e" }, { "url": "https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple&page%5Bsize%5D=25", "sha256": "2c4ad26d5469e398d075690b53aa79261f4883a6730d9ce8a93fa65d6f016b80" } ], "notes": [], "limits": { "note": "GLEIF covers entities with an LEI only; SEC table covers listed US registrants; VIES only EU VAT; officers only from Companies House" } }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:83745ae8-9db4-48af-adfc-bdd61ad6cdf5", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Company identity: name, domain, LEI, VAT, CIK or ticker to one verified legal entity", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T17:55:19.146Z", "softwareAgent": { "name": "writerslogic-agent-hub/company-identity", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/company-identity", "inputDigest": { "alg": "sha256", "hash": "9bdc0cd90bc8a6e0d3b71eb8f2089b3911f92fb3b20638ba724d007b01524fa3", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "0c04ec33d091052da331d59490a6bfb7e6b992e34fd66309fc5bacf5b93e2982", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple+Incorporated&page%5Bsize%5D=25", "format": "application/vnd.api+json", "relationship": "inputTo", "dc": { "source": "https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple+Incorporated&page%5Bsize%5D=25", "date": "2026-11-06T17:55:18.275Z" }, "hash": { "alg": "sha256", "hash": "30e5cb7a678384e308d23658b96c00e643ec776d767db8e9a5aa74ac608bf5a7", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:446464c8-a24a-4987-8b52-4754a1117128", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T17:55:19.146Z", "credentialSubject": { "id": "urn:sha256:0c04ec33d091052da331d59490a6bfb7e6b992e34fd66309fc5bacf5b93e2982", "agent": "company-identity", "endpoint": "POST /api/v1/company-identity", "outputDigest": { "alg": "sha256", "value": "0c04ec33d091052da331d59490a6bfb7e6b992e34fd66309fc5bacf5b93e2982", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "9bdc0cd90bc8a6e0d3b71eb8f2089b3911f92fb3b20638ba724d007b01524fa3", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "cc00dd434c1b8b5f383305d7c23b8a4b2a54015e46341f2157d0270ea5ca3892", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple+Incorporated&page%5Bsize%5D=25", "sha256": "30e5cb7a678384e308d23658b96c00e643ec776d767db8e9a5aa74ac608bf5a7" }, { "url": "https://api.gleif.org/api/v1/lei-records?filter%5Bfulltext%5D=Apple+Inc&page%5Bsize%5D=25", "sha256": "cd1eaeae1e736acf231d531ffbf289052a5507757b679da0dd31c6184db4a27e" }, { "url": "https://api.gleif.org/api/v1/lei-records?filter%5Bentity.legalName%5D=apple&page%5Bsize%5D=25", "sha256": "2c4ad26d5469e398d075690b53aa79261f4883a6730d9ce8a93fa65d6f016b80" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T17:55:19.146Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z2dbbPWpPfEE64gvRcTKDdBCnh8mzhsTxvGs3RorqozEtoHEFUfQHLYhWa3PPp5he8V875oPmjDH8xuiv9JnvUcKb" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:2918892870176d371057ed93d5899ced7db37d5e04476938d8b0375dfea393a7", "signature": "0x88941bd81034a5d3ff06dba58ff03887f185cffd4aa7a4c5467c161675df77c442d511b9d9478bd859b3866a73608c0447efebb2207872b0966f9ad5ac3c81511b" } } } } } }, "400": { "description": "Invalid request. The `error` field names the offending field and `code` is `invalid_request`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "401": { "description": "Missing or invalid RapidAPI key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "402": { "description": "Payment required. The request did not arrive through RapidAPI.", "content": { "application/json": { "schema": { "type": "object", "description": "x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)", "properties": { "x402Version": { "type": "integer" }, "error": { "type": "string" }, "code": { "type": "string" }, "resource": { "type": "object" }, "accepts": { "type": "array", "items": { "type": "object" } }, "extensions": { "type": "object" } } } } } }, "502": { "description": "A source or model this endpoint depends on failed. Retry later; the body carries an `error` message and a `code`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } } }, "externalDocs": { "url": "https://writerslogic.com/agents/company-identity/", "description": "Documentation for Company identity: name, domain, LEI, VAT, CIK or ticker to one verified legal entity: what it does, every input and result field, an example call and the response shape. A free signed sample response is linked from the page." }, "x-tests": [ { "name": "company-identity: unknown field is rejected", "method": "POST", "path": "/v1/company-identity", "body": { "nonsense": true }, "assert": { "status": 400, "json": { "code": "invalid_request" }, "maxMs": 10000 } }, { "name": "company-identity: example returns a signed result", "method": "POST", "path": "/v1/company-identity", "body": { "name": "Apple Inc", "country": "US" }, "assert": { "status": 200, "jsonPathsExist": [ "data", "_provenance.credential" ], "jsonSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "object" }, "status": { "type": "string", "enum": [ "resolved", "ambiguous", "not_found" ] }, "best": { "type": [ "object", "null" ], "properties": { "lei": { "type": "string" }, "legal_name": { "type": "string" }, "other_names": { "type": "array", "items": { "type": "string" } }, "entity_status": { "type": "string" }, "registration_status": { "type": "string" }, "jurisdiction": { "type": "string" }, "legal_form_elf": { "type": [ "string", "null" ] }, "registry": { "type": "object", "properties": { "authority_id": { "type": [ "string", "null" ] }, "registered_as": { "type": [ "string", "null" ] } } }, "legal_address": { "type": [ "object", "null" ], "properties": { "lines": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" } } }, "headquarters_address": { "type": [ "object", "null" ], "properties": { "lines": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "region": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" } } }, "sec": { "type": [ "object", "null" ], "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "title": { "type": "string" } } }, "vat": { "type": [ "object", "null" ], "properties": { "country": { "type": "string" }, "number": { "type": "string" }, "valid": { "type": [ "boolean", "null" ] }, "name": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "checked_at": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } } }, "uk": { "anyOf": [ { "type": "object", "properties": { "company_number": { "type": "string" }, "company_status": { "type": [ "string", "null" ] }, "officers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": [ "string", "null" ] }, "appointed_on": { "type": [ "string", "null" ] } } } } } }, { "type": "string", "enum": [ "not_configured" ] } ] }, "parents": { "type": [ "object", "null" ], "properties": { "direct": { "type": [ "object", "null" ], "properties": { "lei": { "type": "string" }, "legal_name": { "type": "string" }, "jurisdiction": { "type": "string" }, "entity_status": { "type": "string" } } }, "ultimate": { "type": [ "object", "null" ], "properties": { "lei": { "type": "string" }, "legal_name": { "type": "string" }, "jurisdiction": { "type": "string" }, "entity_status": { "type": "string" } } }, "exception": { "type": [ "string", "null" ] } } } } }, "candidates": { "type": "array", "items": { "type": "object", "properties": { "lei": { "type": "string" }, "legal_name": { "type": "string" }, "jurisdiction": { "type": [ "string", "null" ] }, "entity_status": { "type": [ "string", "null" ] }, "score": { "type": "number" } } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "sha256": { "type": "string" } } } }, "notes": { "type": "array", "items": { "type": "string" } }, "limits": { "type": "object", "properties": { "note": { "type": "string" } } } } }, "_provenance": { "type": "object" } }, "required": [ "data", "_provenance" ] }, "maxMs": 120000 } } ] } }, "/v1/open-badges-verifier": { "post": { "operationId": "openBadgesVerifier", "summary": "Open Badges Credential Verifier", "description": "`POST /v1/open-badges-verifier`\n\nVerifies an Open Badges 2.0 or 3.0 credential end to end. Checks required fields, issuance and expiry window, signature, that the signing key belongs to the named issuer, the hosted assertion chain and revocation. Accepts a credential, a JWS, a hosted assertion URL or a baked PNG or SVG, and states what could and could not be confirmed.\n\n**What you get:** A badge that merely renders proves nothing. This call tells an employer, LMS or wallet whether the issuer really signed it, whether it is expired or revoked, and which parts could not be checked, in under ten seconds.\n\n### Use it for\n\n- Check whether an Open Badges credential was really signed by the issuer it names.\n- Tell whether a badge is expired, revoked or malformed, and which parts could not be checked.\n- Verify a hosted assertion URL or a badge baked into a PNG or SVG image.\n\n### Details and limits\n\nVerifies an Open Badges credential end to end and says what could and could not be confirmed. Accepts an Open Badges 3.0 credential (JSON with an eddsa-jcs-2022 proof, or a VC-JWT signed with EdDSA, ES256 or RS256), an Open Badges 2.0 assertion (hosted, or signed as an RS256 JWS), a hosted-assertion URL, or a baked PNG or SVG image. Checks the 2.0/3.0 required fields, the issuance and expiry window, the signature, that the signing key (did:key, did:web, JWKS or CryptographicKey) really belongs to the named issuer, the hosted-assertion, BadgeClass and Issuer chain with allowedOrigins and startsWith rules, and revocation (2.0 revocation lists and revoked flag, 3.0 1EdTechRevocationList and Bitstring status lists). Optionally confirms a recipient's email or identity against the badge's salted hash. Every check is pass, fail, unknown (for example an issuer host was unreachable) or unsupported (for example an RDF-canonicalization proof suite), and the verdict is valid only when nothing failed and nothing is left open. No model is used. Remote documents are fetched through an SSRF-guarded client, at most 12 per call, and JSON-LD contexts are never fetched.\n\n### Request fields\n\nSend these as a JSON body.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `credential` | any | no | The credential or assertion as a JSON object (or the same as a JSON string, or a compact JWS string). |\n| `jws` | string | no | A compact JWS: an Open Badges 3.0 VC-JWT or an Open Badges 2.0 signed assertion. |\n| `url` | string | no | https URL of a hosted Open Badges 2.0 assertion or a hosted 3.0 credential. |\n| `image` | string | no | A baked badge image, base64 (data URLs accepted): a PNG with an openbadges iTXt chunk, or an SVG with an openbadges:assertion or openbadges:credential element. Up to 6 MB decoded. |\n| `recipientIdentity` | string | no | Optional: the recipient's email or other identity to compare against the badge's recipient, including salted sha256$ and md5$ hashes. |\n\n### Example request body\n\n```json\n{\n \"credential\": {\n \"@context\": [\n \"https://www.w3.org/ns/credentials/v2\",\n \"https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json\"\n ],\n \"id\": \"urn:uuid:5b6d2c1e-0c1a-4a52-9a53-0c0f7a1c9e11\",\n \"type\": [\n \"VerifiableCredential\",\n \"OpenBadgeCredential\"\n ],\n \"issuer\": {\n \"id\": \"did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn\",\n \"type\": [\n \"Profile\"\n ],\n \"name\": \"Example University\"\n },\n \"validFrom\": \"2025-01-15T00:00:00Z\",\n \"name\": \"Example Achievement\",\n \"credentialSubject\": {\n \"type\": [\n \"AchievementSubject\"\n ],\n \"identifier\": [\n {\n \"type\": \"IdentityObject\",\n \"hashed\": false,\n \"identityHash\": \"learner@example.org\",\n \"identityType\": \"emailAddress\"\n }\n ],\n \"achievement\": {\n \"id\": \"https://issuer.example/achievements/1\",\n \"type\": [\n \"Achievement\"\n ],\n \"name\": \"Example Achievement\",\n \"description\": \"Awarded for completing the example course.\",\n \"criteria\": {\n \"narrative\": \"Complete all modules with a passing grade.\"\n }\n }\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-jcs-2022\",\n \"created\": \"2025-01-15T00:00:00Z\",\n \"verificationMethod\": \"did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn#z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn\",\n \"proofPurpose\": \"assertionMethod\",\n \"proofValue\": \"z3iyvJ3hfobNHzMPsBC39QPoo57kX7UWTBkCjL7wda4hxWDoeDeb1tQPq7HueQbbAxBEofghDqXa1rG8MEJexaUWt\"\n }\n },\n \"recipientIdentity\": \"learner@example.org\"\n}\n```\n\n### Request (curl)\n\n```bash\ncurl -X POST \"https://$RAPIDAPI_HOST/v1/open-badges-verifier\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-RapidAPI-Key: $RAPIDAPI_KEY\" \\\n -H \"X-RapidAPI-Host: $RAPIDAPI_HOST\" \\\n -d '{\"credential\":{\"@context\":[\"https://www.w3.org/ns/credentials/v2\",\"https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json\"],\"id\":\"urn:uuid:5b6d2c1e-0c1a-4a52-9a53-0c0f7a1c9e11\",\"type\":[\"VerifiableCredential\",\"OpenBadgeCredential\"],\"issuer\":{\"id\":\"did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn\",\"type\":[\"Profile\"],\"name\":\"Example University\"},\"validFrom\":\"2025-01-15T00:00:00Z\",\"name\":\"Example Achievement\",\"credentialSubject\":{\"type\":[\"AchievementSubject\"],\"identifier\":[{\"type\":\"IdentityObject\",\"hashed\":false,\"identityHash\":\"learner@example.org\",\"identityType\":\"emailAddress\"}],\"achievement\":{\"id\":\"https://issuer.example/achievements/1\",\"type\":[\"Achievement\"],\"name\":\"Example Achievement\",\"description\":\"Awarded for completing the example course.\",\"criteria\":{\"narrative\":\"Complete all modules with a passing grade.\"}}},\"proof\":{\"type\":\"DataIntegrityProof\",\"cryptosuite\":\"eddsa-jcs-2022\",\"created\":\"2025-01-15T00:00:00Z\",\"verificationMethod\":\"did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn#z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn\",\"proofPurpose\":\"assertionMethod\",\"proofValue\":\"z3iyvJ3hfobNHzMPsBC39QPoo57kX7UWTBkCjL7wda4hxWDoeDeb1tQPq7HueQbbAxBEofghDqXa1rG8MEJexaUWt\"}},\"recipientIdentity\":\"learner@example.org\"}'\n```\n\n### What comes back\n\nA 200 response is `{ \"data\": ..., \"_provenance\": ... }`. `_provenance` is a signed record of the sources read; the Verify a Signed Result endpoint checks it.\n\nFields of `data`:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `verdict` | enum | invalid: at least one check failed. unverified: nothing failed but some checks are unknown or unsupported. valid: every check passed. |\n| `verdictReason` | string | Verdict reason. |\n| `format` | enum | One of: ob2-hosted, ob2-signed, ob3-credential, ob3-jwt, unrecognized. |\n| `specVersion` | enum | One of: 2.0, 3.0, unknown. |\n| `source` | enum | One of: json, jws, url, png, svg. |\n| `checks` | array of object | Checks, a list of objects. |\n| `summary` | object | Summary, an object. |\n| `badge` | object, nullable | name, description, criteria, image, achievementId, issuer {id, name, url}, issuedOn, expires and credentialId, as read from the verified document; null when unrecognized. |\n| `proof` | object, nullable | type, suite or alg, keyId and keySource of the proof that was checked; null when unrecognized. |\n| `recipient` | object | matched (true, false or null when no identity was supplied) and detail. |\n| `fetched` | array of object | Fetched, a list of objects. |\n| `deterministic` | boolean | Always true: no model is involved. |\n\nExample `data` from a real recorded call (long values shortened):\n\n```json\n{\n \"verdict\": \"valid\",\n \"verdictReason\": \"Every check passed: structure, dates, issuer key, signature, revocation status and, where supplied, the recipient.\",\n \"format\": \"ob3-credential\",\n \"specVersion\": \"3.0\",\n \"source\": \"json\",\n \"checks\": [\n {\n \"id\": \"structure\",\n \"status\": \"pass\",\n \"detail\": \"context, types, issuer, subject and achievement meet the Open Badges 3.0 required fields\"\n },\n {\n \"id\": \"dates\",\n \"status\": \"pass\",\n \"detail\": \"issued 2025-01-15T00:00:00Z; no expiry\"\n },\n {\n \"id\": \"proof-signature\",\n \"status\": \"pass\",\n \"detail\": \"eddsa-jcs-2022 proof verifies\"\n }\n ],\n \"summary\": {\n \"pass\": 6,\n \"fail\": 0,\n \"unknown\": 0,\n \"unsupported\": 0\n },\n \"badge\": {\n \"name\": \"Example Achievement\",\n \"description\": \"Awarded for completing the example course.\",\n \"criteria\": \"Complete all modules with a passing grade.\",\n \"achievementId\": \"https://issuer.example/achievements/1\",\n \"issuer\": {\n \"id\": \"did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn\",\n \"name\": \"Example University\"\n },\n \"issuedOn\": \"2025-01-15T00:00:00Z\",\n \"credentialId\": \"urn:uuid:5b6d2c1e-0c1a-4a52-9a53-0c0f7a1c9e11\"\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"suite\": \"eddsa-jcs-2022\",\n \"keyId\": \"did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn#z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn\",\n \"keySource\": \"did:key\"\n },\n \"recipient\": {\n \"matched\": true,\n \"detail\": \"match\"\n },\n \"fetched\": [],\n \"deterministic\": true\n}\n```\n\n### HTTP response status codes\n\n- 200: success; the body is `{ \"data\": ..., \"_provenance\": ... }`.\n- 400: the request failed validation; `error` names the field and `code` is `invalid_request`.\n- 401: the RapidAPI key or subscription is missing or not valid for this API.\n- 429: the plan's rate limit was reached.\n- 5xx: the call failed on our side or at an upstream source; retry it.\n\nFull field-by-field documentation: https://writerslogic.com/agents/open-badges-verifier/\nMachine-readable input and result schemas: https://writerslogic.com/agents/open-badges-verifier.json", "x-sample-url": "https://agents.writerslogic.com/api/v1/samples/open-badges-verifier", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "credential": { "description": "The credential or assertion as a JSON object (or the same as a JSON string, or a compact JWS string)." }, "jws": { "type": "string", "maxLength": 1000000, "description": "A compact JWS: an Open Badges 3.0 VC-JWT or an Open Badges 2.0 signed assertion." }, "url": { "type": "string", "maxLength": 2000, "description": "https URL of a hosted Open Badges 2.0 assertion or a hosted 3.0 credential." }, "image": { "type": "string", "maxLength": 8500000, "description": "A baked badge image, base64 (data URLs accepted): a PNG with an openbadges iTXt chunk, or an SVG with an openbadges:assertion or openbadges:credential element. Up to 6 MB decoded." }, "recipientIdentity": { "type": "string", "minLength": 1, "maxLength": 320, "description": "Optional: the recipient's email or other identity to compare against the badge's recipient, including salted sha256$ and md5$ hashes." } }, "description": "Input payload for Open Badges 2.0 / 3.0 credential verifier. Required fields: none. Optional fields: `credential`, `jws`, `url`, `image`, `recipientIdentity`.", "externalDocs": { "url": "https://writerslogic.com/agents/open-badges-verifier.json", "description": "Machine-readable record for Open Badges 2.0 / 3.0 credential verifier: the full input and result JSON Schemas, an example payload and the OpenAPI operation." } }, "examples": { "default": { "summary": "Example request for Open Badges 2.0 / 3.0 credential verifier", "description": "A complete valid request body for Open Badges Credential Verifier.", "value": { "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2", "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json" ], "id": "urn:uuid:5b6d2c1e-0c1a-4a52-9a53-0c0f7a1c9e11", "type": [ "VerifiableCredential", "OpenBadgeCredential" ], "issuer": { "id": "did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn", "type": [ "Profile" ], "name": "Example University" }, "validFrom": "2025-01-15T00:00:00Z", "name": "Example Achievement", "credentialSubject": { "type": [ "AchievementSubject" ], "identifier": [ { "type": "IdentityObject", "hashed": false, "identityHash": "learner@example.org", "identityType": "emailAddress" } ], "achievement": { "id": "https://issuer.example/achievements/1", "type": [ "Achievement" ], "name": "Example Achievement", "description": "Awarded for completing the example course.", "criteria": { "narrative": "Complete all modules with a passing grade." } } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2025-01-15T00:00:00Z", "verificationMethod": "did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn#z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn", "proofPurpose": "assertionMethod", "proofValue": "z3iyvJ3hfobNHzMPsBC39QPoo57kX7UWTBkCjL7wda4hxWDoeDeb1tQPq7HueQbbAxBEofghDqXa1rG8MEJexaUWt" } }, "recipientIdentity": "learner@example.org" } } } } }, "description": "JSON request body for Open Badges 2.0 / 3.0 credential verifier. Required fields: none. Optional fields: `credential`, `jws`, `url`, `image`, `recipientIdentity`. Unknown fields are rejected with a 400." }, "responses": { "200": { "description": "Success. `data` holds the answer and `_provenance` holds the signed credential for it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "verdict": { "type": "string", "enum": [ "valid", "invalid", "unverified" ], "description": "invalid: at least one check failed. unverified: nothing failed but some checks are unknown or unsupported. valid: every check passed." }, "verdictReason": { "type": "string", "description": "Verdict reason." }, "format": { "type": "string", "enum": [ "ob2-hosted", "ob2-signed", "ob3-credential", "ob3-jwt", "unrecognized" ], "description": "One of: ob2-hosted, ob2-signed, ob3-credential, ob3-jwt, unrecognized." }, "specVersion": { "type": "string", "enum": [ "2.0", "3.0", "unknown" ], "description": "One of: 2.0, 3.0, unknown." }, "source": { "type": "string", "enum": [ "json", "jws", "url", "png", "svg" ], "description": "One of: json, jws, url, png, svg." }, "checks": { "type": "array", "items": { "type": "object", "description": "id (structure, dates, badge-class, issuer, hosted, proof-signature, issuer-key, jwt-claims, revocation, recipient), status (pass, fail, unknown, unsupported) and detail." }, "description": "Checks, a list of objects." }, "summary": { "type": "object", "properties": { "pass": { "type": "integer", "description": "Pass, a whole number." }, "fail": { "type": "integer", "description": "Fail, a whole number." }, "unknown": { "type": "integer", "description": "Unknown, a whole number." }, "unsupported": { "type": "integer", "description": "Unsupported, a whole number." } }, "description": "Summary, an object." }, "badge": { "type": "object", "description": "name, description, criteria, image, achievementId, issuer {id, name, url}, issuedOn, expires and credentialId, as read from the verified document; null when unrecognized.", "nullable": true }, "proof": { "type": "object", "description": "type, suite or alg, keyId and keySource of the proof that was checked; null when unrecognized.", "nullable": true }, "recipient": { "type": "object", "description": "matched (true, false or null when no identity was supplied) and detail." }, "fetched": { "type": "array", "items": { "type": "object", "description": "url and ok for every remote document requested." }, "description": "Fetched, a list of objects." }, "deterministic": { "type": "boolean", "description": "Always true: no model is involved." } }, "description": "Data, an object." }, "_provenance": { "type": "object", "description": "C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance" } }, "required": [ "data", "_provenance" ] }, "example": { "data": { "verdict": "valid", "verdictReason": "Every check passed: structure, dates, issuer key, signature, revocation status and, where supplied, the recipient.", "format": "ob3-credential", "specVersion": "3.0", "source": "json", "checks": [ { "id": "structure", "status": "pass", "detail": "context, types, issuer, subject and achievement meet the Open Badges 3.0 required fields" }, { "id": "dates", "status": "pass", "detail": "issued 2025-01-15T00:00:00Z; no expiry" }, { "id": "proof-signature", "status": "pass", "detail": "eddsa-jcs-2022 proof verifies" } ], "summary": { "pass": 6, "fail": 0, "unknown": 0, "unsupported": 0 }, "badge": { "name": "Example Achievement", "description": "Awarded for completing the example course.", "criteria": "Complete all modules with a passing grade.", "achievementId": "https://issuer.example/achievements/1", "issuer": { "id": "did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn", "name": "Example University" }, "issuedOn": "2025-01-15T00:00:00Z", "credentialId": "urn:uuid:5b6d2c1e-0c1a-4a52-9a53-0c0f7a1c9e11" }, "proof": { "type": "DataIntegrityProof", "suite": "eddsa-jcs-2022", "keyId": "did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn#z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn", "keySource": "did:key" }, "recipient": { "matched": true, "detail": "match" }, "fetched": [], "deterministic": true }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:e1f2d57b-af30-47f0-87f0-239e0a01e582", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Open Badges 2.0 / 3.0 credential verifier", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T01:30:18.887Z", "softwareAgent": { "name": "writerslogic-agent-hub/open-badges-verifier", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/algorithmicMedia", "parameters": { "endpoint": "POST /api/v1/open-badges-verifier", "inputDigest": { "alg": "sha256", "hash": "13d0ac110cd9c0d1b9d3eb6da9175845b95e5028dd40b53e10fd94b11ced1d19", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "56d854367323775006e058f6a95fa363056df78d85aadadf81c2883d3fc73394", "name": "jcs-canonical-json(data)" } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:feb3a55e-05a5-4657-8308-59197a122721", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T01:30:18.887Z", "credentialSubject": { "id": "urn:sha256:56d854367323775006e058f6a95fa363056df78d85aadadf81c2883d3fc73394", "agent": "open-badges-verifier", "endpoint": "POST /api/v1/open-badges-verifier", "outputDigest": { "alg": "sha256", "value": "56d854367323775006e058f6a95fa363056df78d85aadadf81c2883d3fc73394", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "13d0ac110cd9c0d1b9d3eb6da9175845b95e5028dd40b53e10fd94b11ced1d19", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "0cd738aecaff9339682c1e2aa879d973831419020adff07a2e843125f3a48857", "canonicalization": "JCS" }, "ingredients": [], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T01:30:18.887Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "zPZU4Np69TwK8hkNCjd1nHnDQWWnFLYuJpJrwSH8iBKrnNeRqV4udauiV3Pfb118pVbeV8ruLeqQs4BbWNFKfzii" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:59b6565a47cb997f12866f57bb3c6f6c4535779ab20a92ecc8116c1fbd0b61c8", "signature": "0xdcfff1d865b58a64f581461dab67c9f0fa9e462b4dba864c18cec2a79dcf7344237144d15dce51e45df23fbd95f58eea406eba6102e4182ea4f57c88946c53311c" } } } } } }, "400": { "description": "Invalid request. The `error` field names the offending field and `code` is `invalid_request`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "401": { "description": "Missing or invalid RapidAPI key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "402": { "description": "Payment required. The request did not arrive through RapidAPI.", "content": { "application/json": { "schema": { "type": "object", "description": "x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)", "properties": { "x402Version": { "type": "integer" }, "error": { "type": "string" }, "code": { "type": "string" }, "resource": { "type": "object" }, "accepts": { "type": "array", "items": { "type": "object" } }, "extensions": { "type": "object" } } } } } }, "502": { "description": "A source or model this endpoint depends on failed. Retry later; the body carries an `error` message and a `code`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } } }, "externalDocs": { "url": "https://writerslogic.com/agents/open-badges-verifier/", "description": "Documentation for Open Badges 2.0 / 3.0 credential verifier: what it does, every input and result field, an example call and the response shape. A free signed sample response is linked from the page." }, "x-tests": [ { "name": "open-badges-verifier: unknown field is rejected", "method": "POST", "path": "/v1/open-badges-verifier", "body": { "nonsense": true }, "assert": { "status": 400, "json": { "code": "invalid_request" }, "maxMs": 10000 } }, { "name": "open-badges-verifier: example returns a signed result", "method": "POST", "path": "/v1/open-badges-verifier", "body": { "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2", "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json" ], "id": "urn:uuid:5b6d2c1e-0c1a-4a52-9a53-0c0f7a1c9e11", "type": [ "VerifiableCredential", "OpenBadgeCredential" ], "issuer": { "id": "did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn", "type": [ "Profile" ], "name": "Example University" }, "validFrom": "2025-01-15T00:00:00Z", "name": "Example Achievement", "credentialSubject": { "type": [ "AchievementSubject" ], "identifier": [ { "type": "IdentityObject", "hashed": false, "identityHash": "learner@example.org", "identityType": "emailAddress" } ], "achievement": { "id": "https://issuer.example/achievements/1", "type": [ "Achievement" ], "name": "Example Achievement", "description": "Awarded for completing the example course.", "criteria": { "narrative": "Complete all modules with a passing grade." } } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2025-01-15T00:00:00Z", "verificationMethod": "did:key:z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn#z6MkgAnvkP45uNxwCKeNdt6wrYkEjpYX4f7Nrd8MQqFL8Fbn", "proofPurpose": "assertionMethod", "proofValue": "z3iyvJ3hfobNHzMPsBC39QPoo57kX7UWTBkCjL7wda4hxWDoeDeb1tQPq7HueQbbAxBEofghDqXa1rG8MEJexaUWt" } }, "recipientIdentity": "learner@example.org" }, "assert": { "status": 200, "jsonPathsExist": [ "data", "_provenance.credential" ], "jsonSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "verdict": { "type": "string", "enum": [ "valid", "invalid", "unverified" ] }, "verdictReason": { "type": "string" }, "format": { "type": "string", "enum": [ "ob2-hosted", "ob2-signed", "ob3-credential", "ob3-jwt", "unrecognized" ] }, "specVersion": { "type": "string", "enum": [ "2.0", "3.0", "unknown" ] }, "source": { "type": "string", "enum": [ "json", "jws", "url", "png", "svg" ] }, "checks": { "type": "array", "items": { "type": "object" } }, "summary": { "type": "object", "properties": { "pass": { "type": "integer" }, "fail": { "type": "integer" }, "unknown": { "type": "integer" }, "unsupported": { "type": "integer" } } }, "badge": { "type": [ "object", "null" ] }, "proof": { "type": [ "object", "null" ] }, "recipient": { "type": "object" }, "fetched": { "type": "array", "items": { "type": "object" } }, "deterministic": { "type": "boolean" } } }, "_provenance": { "type": "object" } }, "required": [ "data", "_provenance" ] }, "maxMs": 120000 } } ] } }, "/v1/enrich-lead": { "post": { "operationId": "leadEnrichment", "summary": "B2B Lead Enrichment and Cold Email Draft", "description": "`POST /v1/enrich-lead`\n\nReads a company homepage and returns its value proposition, likely buyer persona and a targeted B2B cold email draft. Send the company URL and, optionally, who you are and what you sell. Works from public homepage text only.\n\n**What you get:** Replaces 10-15 minutes of manual SDR research per account; a single booked meeting from a tailored first touch is worth far more than the call.\n\n### Use it for\n\n- Research a prospect from its homepage: value proposition and likely buyer persona.\n- Get a targeted first-touch cold email draft you can edit.\n- Prepare account research before outreach without manual reading.\n\n### Details and limits\n\nScrapes a company homepage, deduces its value proposition and buyer persona, and drafts a targeted B2B cold email.\n\n### Request fields\n\nSend these as a JSON body.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `url` | string | yes | Company homepage URL; https:// is assumed if omitted. |\n| `senderContext` | string | no | What you sell, used to tailor the pitch. |\n\n### Example request body\n\n```json\n{\n \"url\": \"https://stripe.com\",\n \"senderContext\": \"We sell AI-driven chargeback dispute automation for online merchants.\"\n}\n```\n\n### Request (curl)\n\n```bash\ncurl -X POST \"https://$RAPIDAPI_HOST/v1/enrich-lead\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-RapidAPI-Key: $RAPIDAPI_KEY\" \\\n -H \"X-RapidAPI-Host: $RAPIDAPI_HOST\" \\\n -d '{\"url\":\"https://stripe.com\",\"senderContext\":\"We sell AI-driven chargeback dispute automation for online merchants.\"}'\n```\n\n### What comes back\n\nA 200 response is `{ \"data\": ..., \"_provenance\": ... }`. `_provenance` is a signed record of the sources read; the Verify a Signed Result endpoint checks it.\n\nFields of `data`:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `company_name` | string | Company name. |\n| `industry` | string | Industry. |\n| `value_proposition` | string | Model claim whose supporting quote was verified on the page; otherwise the page's own description, or \"unclear\". |\n| `target_customers` | array of string | Target customers, a list of strings. |\n| `key_offerings` | array of string | Only offerings whose supporting quote appears verbatim in the page text; see claim_evidence. |\n| `buyer_persona` | object | Buyer persona, an object. |\n| `cold_email` | object | Cold email, an object. |\n| `source_url` | string | Source URL. |\n| `page_title` | string | Page title. |\n| `company_name_source` | enum | Where company_name came from; parsed values are never model-generated. |\n| `contact` | object | Contact, an object. |\n| `pages_read` | array of string | Extra same-site pages (about, pricing, customers, careers) read besides the homepage. |\n| `fallbacks_used` | array of string | Sources used because the homepage had little readable text. |\n| `claim_evidence` | object | Verbatim page snippets behind the value proposition, offerings and pain points; claims without a verified snippet are dropped and counted. |\n| `email_check` | object | Email check, an object. |\n\nExample `data` from a real recorded call (long values shortened):\n\n```json\n{\n \"source_url\": \"https://stripe.com/\",\n \"page_title\": \"Stripe | Financial Infrastructure to Grow Your Revenue\",\n \"company_name\": \"Stripe\",\n \"industry\": \"Financial technology (payments and financial infrastructure)\",\n \"value_proposition\": \"Stripe sells programmable financial infrastructure covering payments, billing, banking and money movement to businesses of all sizes, from startups to enterp...\",\n \"target_customers\": [\n \"Businesses of all sizes, from solo founders to large enterprises\",\n \"Startups, including AI companies\",\n \"Vertical SaaS platforms and marketplaces\"\n ],\n \"key_offerings\": [\n \"Payments (online and in person)\",\n \"Billing and no-code dashboard tools\",\n \"Connect (embedded payments for platforms)\"\n ],\n \"buyer_persona\": {\n \"title\": \"Head of Risk Products (Payments Risk and Disputes)\",\n \"pain_points\": [\n \"Platforms and merchants need to manage risk, fraud and compliance as they scale\",\n \"Pressure to keep acceptance rates and checkout conversion high while controlling fraud losses\",\n \"Ongoing need to invest in risk and fraud infrastructure to keep the internet economy safe\"\n ]\n },\n \"cold_email\": {\n \"subject\": \"Chargeback automation for Stripe merchants\",\n \"body\": \"Hi {{first_name}},\\n\\nI noticed Stripe offers built-in fraud prevention through Radar and gives platforms tools to manage risk as they scale. Disputes are an a...\"\n },\n \"company_name_source\": \"json-ld\",\n \"contact\": {\n \"emails\": [\n \"jane.diaz@example.com\",\n \"jane.diaz@stripe.com\",\n \"damian.michelfelder@example.com\"\n ],\n \"phones\": [],\n \"social_links\": [\n \"https://twitter.com/stripe\",\n \"https://youtube.com/@stripe\",\n \"https://youtube.com/@StripeDev\"\n ],\n \"address\": \"60 Anson Road #05-01, Singapore, 079914, SG\"\n },\n \"pages_read\": [\n \"https://stripe.com/about\",\n \"https://stripe.com/pricing\",\n \"https://stripe.com/customers\"\n ],\n \"fallbacks_used\": [],\n \"claim_evidence\": {\n \"value_proposition\": {\n \"quote\": \"We build programmable financial infrastructure, rethinking from first principles how financial services should work, to make it easier and cheaper for any bu...\"\n },\n \"key_offerings\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"pain_points\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"dropped_unsupported\": 0\n }\n}\n```\n\n### HTTP response status codes\n\n- 200: success; the body is `{ \"data\": ..., \"_provenance\": ... }`.\n- 400: the request failed validation; `error` names the field and `code` is `invalid_request`.\n- 401: the RapidAPI key or subscription is missing or not valid for this API.\n- 429: the plan's rate limit was reached.\n- 5xx: the call failed on our side or at an upstream source; retry it.\n\nFull field-by-field documentation: https://writerslogic.com/agents/lead-enrichment/\nMachine-readable input and result schemas: https://writerslogic.com/agents/lead-enrichment.json", "x-sample-url": "https://agents.writerslogic.com/api/v1/samples/lead-enrichment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "minLength": 3, "maxLength": 2048, "description": "Company homepage URL; https:// is assumed if omitted." }, "senderContext": { "type": "string", "maxLength": 2000, "description": "What you sell, used to tailor the pitch." } }, "description": "Input payload for Autonomous Lead Enrichment. Required fields: `url`. Optional fields: `senderContext`.", "externalDocs": { "url": "https://writerslogic.com/agents/lead-enrichment.json", "description": "Machine-readable record for Autonomous Lead Enrichment: the full input and result JSON Schemas, an example payload and the OpenAPI operation." } }, "examples": { "default": { "summary": "Example request for Autonomous Lead Enrichment", "description": "A complete valid request body for B2B Lead Enrichment and Cold Email Draft.", "value": { "url": "https://stripe.com", "senderContext": "We sell AI-driven chargeback dispute automation for online merchants." } } } } }, "description": "JSON request body for Autonomous Lead Enrichment. Required fields: `url`. Optional fields: `senderContext`. Unknown fields are rejected with a 400." }, "responses": { "200": { "description": "Success. `data` holds the answer and `_provenance` holds the signed credential for it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "required": [ "company_name", "industry", "value_proposition", "target_customers", "key_offerings", "buyer_persona", "cold_email", "source_url", "page_title", "company_name_source", "contact", "pages_read", "fallbacks_used", "claim_evidence", "email_check" ], "properties": { "company_name": { "type": "string", "description": "Company name." }, "industry": { "type": "string", "description": "Industry." }, "value_proposition": { "type": "string", "description": "Model claim whose supporting quote was verified on the page; otherwise the page's own description, or \"unclear\"." }, "target_customers": { "type": "array", "items": { "type": "string" }, "description": "Target customers, a list of strings." }, "key_offerings": { "type": "array", "items": { "type": "string" }, "description": "Only offerings whose supporting quote appears verbatim in the page text; see claim_evidence." }, "buyer_persona": { "type": "object", "required": [ "title", "pain_points" ], "properties": { "title": { "type": "string", "description": "Title." }, "pain_points": { "type": "array", "items": { "type": "string" }, "description": "Only pain points backed by a verified page quote." } }, "description": "Buyer persona, an object." }, "cold_email": { "type": "object", "required": [ "subject", "body" ], "properties": { "subject": { "type": "string", "description": "Subject." }, "body": { "type": "string", "description": "Body." } }, "description": "Cold email, an object." }, "source_url": { "type": "string", "description": "Source URL." }, "page_title": { "type": "string", "description": "Page title." }, "company_name_source": { "type": "string", "enum": [ "json-ld", "og:site_name", "model" ], "description": "Where company_name came from; parsed values are never model-generated." }, "contact": { "type": "object", "additionalProperties": false, "required": [ "emails", "phones", "social_links", "address" ], "properties": { "emails": { "type": "array", "items": { "type": "string" }, "description": "Emails, a list of strings." }, "phones": { "type": "array", "items": { "type": "string" }, "description": "Phones, a list of strings." }, "social_links": { "type": "array", "items": { "type": "string" }, "description": "Social links, a list of strings." }, "address": { "type": "string", "description": "Empty string when none was found." } }, "description": "Contact, an object." }, "pages_read": { "type": "array", "items": { "type": "string" }, "description": "Extra same-site pages (about, pricing, customers, careers) read besides the homepage." }, "fallbacks_used": { "type": "array", "items": { "type": "string", "enum": [ "json-ld", "sitemap", "about-page" ] }, "description": "Sources used because the homepage had little readable text." }, "claim_evidence": { "type": "object", "description": "Verbatim page snippets behind the value proposition, offerings and pain points; claims without a verified snippet are dropped and counted.", "properties": { "value_proposition": { "type": "object", "properties": { "quote": { "type": "string", "description": "Quote." } }, "nullable": true, "description": "Value proposition, an object." }, "key_offerings": { "type": "array", "items": { "type": "object", "properties": { "claim": { "type": "string", "description": "Claim." }, "snippet": { "type": "string", "description": "Snippet." } } }, "description": "Key offerings, a list of objects." }, "pain_points": { "type": "array", "items": { "type": "object", "properties": { "claim": { "type": "string", "description": "Claim." }, "snippet": { "type": "string", "description": "Snippet." } } }, "description": "Pain points, a list of objects." }, "dropped_unsupported": { "type": "integer", "description": "Dropped unsupported, a whole number." } } }, "email_check": { "type": "object", "additionalProperties": false, "required": [ "passed", "violations", "retried" ], "properties": { "passed": { "type": "boolean", "description": "Passed, true or false." }, "violations": { "type": "array", "items": { "type": "string" }, "description": "Violations, a list of strings." }, "retried": { "type": "boolean", "description": "Retried, true or false." } }, "description": "Email check, an object." } }, "description": "Data, an object." }, "_provenance": { "type": "object", "description": "C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance" } }, "required": [ "data", "_provenance" ] }, "example": { "data": { "source_url": "https://stripe.com/", "page_title": "Stripe | Financial Infrastructure to Grow Your Revenue", "company_name": "Stripe", "industry": "Financial technology (payments and financial infrastructure)", "value_proposition": "Stripe sells programmable financial infrastructure covering payments, billing, banking and money movement to businesses of all sizes, from startups to enterprises. It wins by making it easier and cheaper to start and scale globally.", "target_customers": [ "Businesses of all sizes, from solo founders to large enterprises", "Startups, including AI companies", "Vertical SaaS platforms and marketplaces" ], "key_offerings": [ "Payments (online and in person)", "Billing and no-code dashboard tools", "Connect (embedded payments for platforms)" ], "buyer_persona": { "title": "Head of Risk Products (Payments Risk and Disputes)", "pain_points": [ "Platforms and merchants need to manage risk, fraud and compliance as they scale", "Pressure to keep acceptance rates and checkout conversion high while controlling fraud losses", "Ongoing need to invest in risk and fraud infrastructure to keep the internet economy safe" ] }, "cold_email": { "subject": "Chargeback automation for Stripe merchants", "body": "Hi {{first_name}},\n\nI noticed Stripe offers built-in fraud prevention through Radar and gives platforms tools to manage risk as they scale. Disputes are an adjacent problem: gathering evidence, formatting responses and meeting deadlines for every chargeback.\n\nWe build AI-driven chargeback dispute..." }, "company_name_source": "json-ld", "contact": { "emails": [ "jane.diaz@example.com", "jane.diaz@stripe.com", "damian.michelfelder@example.com" ], "phones": [], "social_links": [ "https://twitter.com/stripe", "https://youtube.com/@stripe", "https://youtube.com/@StripeDev" ], "address": "60 Anson Road #05-01, Singapore, 079914, SG" }, "pages_read": [ "https://stripe.com/about", "https://stripe.com/pricing", "https://stripe.com/customers" ], "fallbacks_used": [], "claim_evidence": { "value_proposition": { "quote": "We build programmable financial infrastructure, rethinking from first principles how financial services should work, to make it easier and cheaper for any business to start and scale." }, "key_offerings": [ { "claim": "Payments (online and in person)", "snippet": "Optimize checkout conversion, accept local payment methods, and increase acceptance rates." }, { "claim": "Billing and no-code dashboard tools", "snippet": "Set up billing, take in-person payments, or share a payment link—right from the Stripe Dashboard, no code required." }, { "claim": "Connect (embedded payments for platforms)", "snippet": "Launch and scale payments products with lower operational overhead using embedded components and no-code tools." } ], "pain_points": [ { "claim": "Platforms and merchants need to manage risk, fraud and compliance as they scale", "snippet": "Stay ahead of global regulations with tools for compliance, credit risk, fraud prevention, and account security." }, { "claim": "Pressure to keep acceptance rates and checkout conversion high while controlling fraud losses", "snippet": "Optimize checkout conversion, accept local payment methods, and increase acceptance rates." }, { "claim": "Ongoing need to invest in risk and fraud infrastructure to keep the internet economy safe", "snippet": "our significant advances in risk and fraud infrastructure over many years are making the internet economy safer and more accessible." } ], "dropped_unsupported": 0 }, "email_check": { "passed": true, "violations": [], "retried": false } }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:384cfc59-f6be-4383-b8ad-468733003cca", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Autonomous Lead Enrichment", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-04T20:25:21.575Z", "softwareAgent": { "name": "writerslogic-agent-hub/lead-enrichment", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/enrich-lead", "inputDigest": { "alg": "sha256", "hash": "21eb2979ed634ae405cf05d7ca67de57a2a4b6973484c8eeb7c708a7e6227051", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "db8f3471a7a7800fb146a808fd16c29596fa2908d39111eaa3dd8752ce881e6f", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://stripe.com/", "format": "text/html", "relationship": "inputTo", "dc": { "source": "https://stripe.com/", "date": "2026-11-04T20:24:57.593Z" }, "hash": { "alg": "sha256", "hash": "6e6e2d6e2f182cdec922789405c841a5552c7bac0ee086c058ef49153ef01a0c", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:af821779-5f73-4c79-8fd2-84e1feb39199", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-04T20:25:21.575Z", "credentialSubject": { "id": "urn:sha256:db8f3471a7a7800fb146a808fd16c29596fa2908d39111eaa3dd8752ce881e6f", "agent": "lead-enrichment", "endpoint": "POST /api/v1/enrich-lead", "outputDigest": { "alg": "sha256", "value": "db8f3471a7a7800fb146a808fd16c29596fa2908d39111eaa3dd8752ce881e6f", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "21eb2979ed634ae405cf05d7ca67de57a2a4b6973484c8eeb7c708a7e6227051", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "79fe573b3dbb936ed12aebc62a44e666ea3f32b6ee312f5997bcfa6fa65c7143", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://stripe.com/", "sha256": "6e6e2d6e2f182cdec922789405c841a5552c7bac0ee086c058ef49153ef01a0c" }, { "url": "https://stripe.com/about", "sha256": "5532bc240713a7cffcbad4d94892d3b479664f6b3a430d8966e843b4a78c468b" }, { "url": "https://stripe.com/pricing", "sha256": "12e9d70abe9f258899d82cad3973fb44325f2fc99fa78b96771f93984a89f28b" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-04T20:25:21.575Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "zAG3PFyseN7X3CxpGhJuKDtAGigVpgGWZgFsRJHGTnK5cVNRb8yRfCpwy6EpwrAQ9d3ZyZc2hjAHCgn1ZtJ6Fdcq" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:c0c06a118b899ed412f3dad2b0bd864e516ea690b75b3d736eb212fcd0f9934d", "signature": "0x35e2b438117a2ee8cd7cd57d932c61c5cb1b6ea1c252deebe7849dd279306ad41c379eb6282d4a57b189cb6fed8a84e548e13b8765013ef84c44ff0b440ca8341b" } } } } } }, "400": { "description": "Invalid request. The `error` field names the offending field and `code` is `invalid_request`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "401": { "description": "Missing or invalid RapidAPI key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "402": { "description": "Payment required. The request did not arrive through RapidAPI.", "content": { "application/json": { "schema": { "type": "object", "description": "x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)", "properties": { "x402Version": { "type": "integer" }, "error": { "type": "string" }, "code": { "type": "string" }, "resource": { "type": "object" }, "accepts": { "type": "array", "items": { "type": "object" } }, "extensions": { "type": "object" } } } } } }, "502": { "description": "A source or model this endpoint depends on failed. Retry later; the body carries an `error` message and a `code`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } } }, "externalDocs": { "url": "https://writerslogic.com/agents/lead-enrichment/", "description": "Documentation for Autonomous Lead Enrichment: what it does, every input and result field, an example call and the response shape. A free signed sample response is linked from the page." }, "x-tests": [ { "name": "lead-enrichment: unknown field is rejected", "method": "POST", "path": "/v1/enrich-lead", "body": { "nonsense": true }, "assert": { "status": 400, "json": { "code": "invalid_request" }, "maxMs": 10000 } }, { "name": "lead-enrichment: example returns a signed result", "method": "POST", "path": "/v1/enrich-lead", "body": { "url": "https://stripe.com", "senderContext": "We sell AI-driven chargeback dispute automation for online merchants." }, "assert": { "status": 200, "jsonPathsExist": [ "data", "_provenance.credential" ], "jsonSchema": { "type": "object", "properties": { "data": { "type": "object", "required": [ "company_name", "industry", "value_proposition", "target_customers", "key_offerings", "buyer_persona", "cold_email", "source_url", "page_title", "company_name_source", "contact", "pages_read", "fallbacks_used", "claim_evidence", "email_check" ], "properties": { "company_name": { "type": "string" }, "industry": { "type": "string" }, "value_proposition": { "type": "string" }, "target_customers": { "type": "array", "items": { "type": "string" } }, "key_offerings": { "type": "array", "items": { "type": "string" } }, "buyer_persona": { "type": "object", "required": [ "title", "pain_points" ], "properties": { "title": { "type": "string" }, "pain_points": { "type": "array", "items": { "type": "string" } } } }, "cold_email": { "type": "object", "required": [ "subject", "body" ], "properties": { "subject": { "type": "string" }, "body": { "type": "string" } } }, "source_url": { "type": "string" }, "page_title": { "type": "string" }, "company_name_source": { "type": "string", "enum": [ "json-ld", "og:site_name", "model" ] }, "contact": { "type": "object", "required": [ "emails", "phones", "social_links", "address" ], "properties": { "emails": { "type": "array", "items": { "type": "string" } }, "phones": { "type": "array", "items": { "type": "string" } }, "social_links": { "type": "array", "items": { "type": "string" } }, "address": { "type": "string" } } }, "pages_read": { "type": "array", "items": { "type": "string" } }, "fallbacks_used": { "type": "array", "items": { "type": "string", "enum": [ "json-ld", "sitemap", "about-page" ] } }, "claim_evidence": { "type": "object", "properties": { "value_proposition": { "type": [ "object", "null" ], "properties": { "quote": { "type": "string" } } }, "key_offerings": { "type": "array", "items": { "type": "object", "properties": { "claim": { "type": "string" }, "snippet": { "type": "string" } } } }, "pain_points": { "type": "array", "items": { "type": "object", "properties": { "claim": { "type": "string" }, "snippet": { "type": "string" } } } }, "dropped_unsupported": { "type": "integer" } } }, "email_check": { "type": "object", "required": [ "passed", "violations", "retried" ], "properties": { "passed": { "type": "boolean" }, "violations": { "type": "array", "items": { "type": "string" } }, "retried": { "type": "boolean" } } } } }, "_provenance": { "type": "object" } }, "required": [ "data", "_provenance" ] }, "maxMs": 120000 } } ] } }, "/v1/competitor-battlecard": { "post": { "operationId": "competitorBattlecard", "summary": "Competitor Pricing Battlecard", "description": "`POST /v1/competitor-battlecard`\n\nReads up to 3 competitor sites (homepage and pricing page) and returns a sales battlecard. It has a verdict with confidence, pricing tiers checked against the page text, a scenario cost comparison computed in code, hidden fees, objection handling and a talk track. Unverified prices are flagged. If a site fails you get a signed partial result that names what is missing.\n\n**What you get:** A live battlecard before a competitive deal replaces hours of analyst research and arms reps with questions that expose the rival's limits.\n\n### Use it for\n\n- Prepare for a competitive deal with a battlecard built from up to three competitor sites.\n- Compare pricing tiers with a scenario cost computed in code, and see hidden fees and limits.\n- Get landmine questions, objection handling and a talk track for the sales team.\n\n### Details and limits\n\nReads up to 3 competitor sites (homepage and pricing page, fetched in parallel) and returns a deal battlecard in under a minute: a verdict headline with confidence, pricing tiers whose amounts are checked against the page text, a scenario cost comparison computed in code, hidden fees and limits, landmine questions, objection handling, wedge features and a talk track. If a site or model step fails you get a signed partial result that names what is missing. Pricing is only as current as the public pages; unverified prices are flagged.\n\n### Request fields\n\nSend these as a JSON body.\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `ourProductDescription` | string | yes | Our product description. Up to 4,000 characters. |\n| `competitorUrls` | array of string | yes | Competitor homepage or pricing URLs. A same-site pricing page is discovered automatically. |\n| `scenario` | object | no | Optional deal size used to compute monthly and annual cost per verified tier: seats for per-seat prices, monthlyVolume for usage prices. |\n\n### Example request body\n\n```json\n{\n \"ourProductDescription\": \"Acme Support is an AI-first help desk with usage-based pricing ($0.40 per resolved ticket), SSO on every plan, and native Slack and Shopify integrations.\",\n \"competitorUrls\": [\n \"https://www.zendesk.com\",\n \"https://www.intercom.com\",\n \"https://www.freshworks.com/freshdesk/\"\n ]\n}\n```\n\n### Request (curl)\n\n```bash\ncurl -X POST \"https://$RAPIDAPI_HOST/v1/competitor-battlecard\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-RapidAPI-Key: $RAPIDAPI_KEY\" \\\n -H \"X-RapidAPI-Host: $RAPIDAPI_HOST\" \\\n -d '{\"ourProductDescription\":\"Acme Support is an AI-first help desk with usage-based pricing ($0.40 per resolved ticket), SSO on every plan, and native Slack and Shopify integrations.\",\"competitorUrls\":[\"https://www.zendesk.com\",\"https://www.intercom.com\",\"https://www.freshworks.com/freshdesk/\"]}'\n```\n\n### What comes back\n\nA 200 response is `{ \"data\": ..., \"_provenance\": ... }`. `_provenance` is a signed record of the sources read; the Verify a Signed Result endpoint checks it.\n\nFields of `data`:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `our_positioning` | string | Our positioning. |\n| `competitors` | array of object | Competitors, a list of objects. |\n| `talk_track` | string | A 3-5 sentence opener for a live deal against these competitors. |\n| `evidence_gaps` | array of string | What could not be verified from the scraped pages. |\n| `pricing_comparison` | string | Computed in code from prices verified on the scraped pages; the model does not write it. |\n| `pricing_scenario` | object | Monthly and annual cost per verified tier at the scenario. assumed is true when no scenario was given and 10 seats / 1,000 monthly units were used. |\n| `status` | enum | partial when a fetch or model step failed; missing lists what. |\n| `headline` | string | One-paragraph verdict: competitors analyzed, pricing published, verified-tier count, lowest verified cost at the scenario. |\n| `confidence` | enum | high only when every priced tier was verified against the page and nothing is missing. |\n| `next_steps` | array of string | Next steps, a list of strings. |\n| `missing` | array of string | Sections that could not be produced (failed fetches or model steps); empty when status is complete. |\n| `elapsedMs` | integer | Elapsed ms, a whole number. |\n| `priceVerification` | array of object | Per model-written tier: verified \\| unverified \\| no_amount against the scraped text. |\n| `pricingEvidence` | array of object | Per competitor: whether any price or structured offer was found (pricingPublished). |\n| `pagesScraped` | array of string | Pages scraped, a list of strings. |\n| `fetchFailures` | array of object | Fetch failures, a list of objects. |\n| `generatedAt` | string | Generated at. |\n\nExample `data` from a real recorded call (long values shortened):\n\n```json\n{\n \"status\": \"complete\",\n \"headline\": \"3 competitors analyzed; pricing published for 3; 11 of 11 priced tiers verified on the page. Lowest verified cost at the scenario: Zendesk Support Team, USD ...\",\n \"confidence\": \"high\",\n \"next_steps\": [\n \"Use the landmine questions and talk_track in the first call; confirm any claim marked in evidence_gaps with the prospect.\"\n ],\n \"missing\": [],\n \"our_positioning\": \"Acme Support is an AI-first help desk priced per resolved ticket at $0.40, so cost tracks outcomes rather than headcount or a stack of metered add-ons. SSO i...\",\n \"competitors\": [\n {\n \"name\": \"Zendesk\",\n \"url\": \"https://www.zendesk.com/\",\n \"positioning\": \"An AI-first customer service platform where self-learning AI agents resolve issues end-to-end, claiming up to 80% automation across channels.\",\n \"target_segment\": \"Support teams from startups to large enterprises, with heavy emphasis on AI-driven automation and enterprise/contact-center buyers.\",\n \"pricing_model\": \"Primarily seat-based (per agent, per month) with plan tiers; enterprise plans are sales-assisted, and some AI and add-on usage appears metered.\",\n \"pricing_tiers\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"hidden_fees_and_limits\": [\n \"Quoted prices are per agent and 'paid yearly', so the monthly-billing price is not shown.\",\n \"Pricing is primarily seat-based, so cost scales with headcount.\",\n \"Add-ons beyond Copilot require contacting sales.\"\n ],\n \"enterprise_upsell_triggers\": [\n \"Advanced security and governance are positioned in the Enterprise tier.\",\n \"Enterprise plans cannot be assumed to be purchasable online; they are sales-assisted.\",\n \"Generative AI for Voice and the full Copilot are listed under Suite Enterprise + Copilot.\"\n ],\n \"strengths\": [\n \"Broad platform covering ticketing, voice, messaging, QA, workforce management and ITSM.\",\n \"Large ecosystem with 1,800+ marketplace apps and support for 80+ languages.\",\n \"Strong market credibility, including a Gartner Magic Quadrant Leader claim and 22,000+ service teams on its AI.\"\n ],\n \"weaknesses\": [\n \"Seat-based pricing means cost grows with headcount rather than with outcomes.\",\n \"The Enterprise price is not published and requires a sales conversation.\",\n \"Several metered items (actions, MAUs, notifications, automated resolutions) make total cost harder to predict.\"\n ],\n \"landmine_questions\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"objection_handling\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"wedge_features\": [\n \"...\",\n \"...\",\n \"...\"\n ]\n },\n {\n \"name\": \"Intercom\",\n \"url\": \"https://www.intercom.com/\",\n \"positioning\": \"A complete system for human and AI customer service: the only helpdesk with a natively integrated AI Agent (Fin), so every conversation improves the next.\",\n \"target_segment\": \"Startups, small businesses and enterprise support teams that want one platform for AI and human support.\",\n \"pricing_model\": \"Hybrid: per-seat plans (Essential, Advanced, Expert) plus usage-based charges (Fin at $0.99 per outcome, messaging channels, add-ons).\",\n \"pricing_tiers\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"hidden_fees_and_limits\": [\n \"Fin costs $0.99 per outcome on top of per-seat fees.\",\n \"An outcome also counts when a customer simply doesn't ask for more help after Fin responds.\",\n \"Fin on an existing helpdesk carries a minimum monthly commitment (e.g. 50 outcomes).\"\n ],\n \"enterprise_upsell_triggers\": [\n \"SSO & identity management appears only in the Expert tier.\",\n \"SLAs and multibrand Messenger/Help Center are Expert-tier features.\",\n \"Premier Support, onboarding and custom terms require a contract.\"\n ],\n \"strengths\": [\n \"Helpdesk and AI agent are natively integrated in one inbox and knowledge base.\",\n \"Claims Fin averages a 76% resolution rate across 12,000+ customers (vendor claim).\",\n \"Fin deploys across phone, email, chat and Slack, and integrates with Slack, Shopify and Github.\"\n ],\n \"weaknesses\": [\n \"Customers pay twice: per seat plus per Fin outcome, plus add-ons, which makes total cost harder to forecast.\",\n \"SSO is gated to the top Expert tier.\",\n \"Outcome definition can bill for conversations without a confirmed resolution.\"\n ],\n \"landmine_questions\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"objection_handling\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"wedge_features\": [\n \"...\",\n \"...\",\n \"...\"\n ]\n },\n {\n \"name\": \"Freshdesk (Freshworks)\",\n \"url\": \"https://www.freshworks.com/freshdesk/\",\n \"positioning\": \"AI-powered customer service software that combines ready-to-use AI, people and workflows, with a guided path from a first AI agent to AI across all of custom...\",\n \"target_segment\": \"Support teams from small to enterprise, moving step by step toward AI-driven service with per-agent seats. The page also cites 50,000+ and 74,000+ businesses...\",\n \"pricing_model\": \"Per agent per month, billed annually, plus metered AI and usage add-ons (AI sessions, day passes, connector tasks, MCP actions, Copilot).\",\n \"pricing_tiers\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"hidden_fees_and_limits\": [\n \"Prices are shown as billed annually; no monthly price appears on the scraped page.\",\n \"The 500 free AI Agent sessions are once per account, then $49/100 sessions.\",\n \"Freddy AI Copilot costs an extra $29/agent/month.\"\n ],\n \"enterprise_upsell_triggers\": [\n \"Allowed domains and IP whitelisting are listed only under Enterprise.\",\n \"Multilingual, custom dashboards, multiple SLA policies and external collaborators are listed from Pro up.\",\n \"Exhausting the 500 free AI sessions forces paid session purchases.\"\n ],\n \"strengths\": [\n \"The entry price is low, at $19/agent/month on Growth.\",\n \"It has broad brand reach, citing 50,000+ and 74,000+ businesses and a G2 adoption recognition.\",\n \"It offers omnichannel ticketing, a knowledge base, a shared inbox and SLA tooling.\"\n ],\n \"weaknesses\": [\n \"Cost is hard to predict because seats are combined with metered AI sessions, tasks, actions and day passes.\",\n \"AI Copilot is an extra per-agent fee on top of the plan.\",\n \"The 'up to 80%' resolution claim is generic and unsubstantiated on the page.\"\n ],\n \"landmine_questions\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"objection_handling\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"wedge_features\": [\n \"...\",\n \"...\",\n \"...\"\n ]\n }\n ],\n \"talk_track\": \"Thanks for walking us through your team's setup. The main thing we hear from teams like yours is that seat-based and metered pricing makes the bill hard to f...\",\n \"evidence_gaps\": [\n \"The Suite Enterprise + Copilot price is not shown on the scraped pages.\",\n \"The $50, $83, $149, $1.50 and $2.00 figures appear on the pricing page without clear tier or product attribution, so they are not assigned to any tier.\",\n \"Whether SSO/SAML or audit logs are gated to a specific plan was not verifiable.\"\n ],\n \"priceVerification\": [\n {\n \"competitor\": \"Zendesk\",\n \"tier\": \"Support Team\",\n \"price\": \"$19 agent/month paid yearly\",\n \"status\": \"verified\"\n },\n {\n \"competitor\": \"Zendesk\",\n \"tier\": \"Suite Team\",\n \"price\": \"$55 agent/month paid yearly\",\n \"status\": \"verified\"\n },\n {\n \"competitor\": \"Zendesk\",\n \"tier\": \"Suite Professional\",\n \"price\": \"$115 agent/month paid yearly\",\n \"status\": \"verified\"\n }\n ],\n \"pricing_comparison\": \"Ours: USD 0.4 per unit = USD 400/month at the scenario.\\nZendesk / Support Team: $19 agent/month paid yearly = USD 190/month at the scenario.\\nZendesk / Suite ...\",\n \"pricing_scenario\": {\n \"seats\": 10,\n \"monthlyVolume\": 1000,\n \"ours\": {\n \"monthly\": 400,\n \"annual\": 4800,\n \"currency\": \"USD\"\n },\n \"competitors\": [\n \"...\",\n \"...\",\n \"...\"\n ],\n \"assumed\": true\n },\n \"pricingEvidence\": [\n {\n \"url\": \"https://www.zendesk.com/\",\n \"pricingPageScraped\": true,\n \"pricesFound\": 17,\n \"structuredOffers\": 0,\n \"pricingPublished\": true\n },\n {\n \"url\": \"https://www.intercom.com/\",\n \"pricingPageScraped\": true,\n \"pricesFound\": 20,\n \"structuredOffers\": 6,\n \"pricingPublished\": true\n },\n {\n \"url\": \"https://www.freshworks.com/freshdesk/\",\n \"pricingPageScraped\": true,\n \"pricesFound\": 23,\n \"structuredOffers\": 0,\n \"pricingPublished\": true\n }\n ],\n \"pagesScraped\": [\n \"https://www.zendesk.com/\",\n \"https://www.zendesk.com/pricing/\",\n \"https://www.intercom.com/\"\n ]\n}\n```\n\n### HTTP response status codes\n\n- 200: success; the body is `{ \"data\": ..., \"_provenance\": ... }`.\n- 400: the request failed validation; `error` names the field and `code` is `invalid_request`.\n- 401: the RapidAPI key or subscription is missing or not valid for this API.\n- 429: the plan's rate limit was reached.\n- 5xx: the call failed on our side or at an upstream source; retry it.\n\nFull field-by-field documentation: https://writerslogic.com/agents/competitor-battlecard/\nMachine-readable input and result schemas: https://writerslogic.com/agents/competitor-battlecard.json", "x-sample-url": "https://agents.writerslogic.com/api/v1/samples/competitor-battlecard", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ourProductDescription", "competitorUrls" ], "properties": { "ourProductDescription": { "type": "string", "minLength": 20, "maxLength": 4000, "description": "Our product description. Up to 4,000 characters." }, "competitorUrls": { "type": "array", "minItems": 1, "maxItems": 3, "items": { "type": "string", "minLength": 3, "maxLength": 2048 }, "description": "Competitor homepage or pricing URLs. A same-site pricing page is discovered automatically." }, "scenario": { "type": "object", "additionalProperties": false, "description": "Optional deal size used to compute monthly and annual cost per verified tier: seats for per-seat prices, monthlyVolume for usage prices.", "properties": { "seats": { "type": "integer", "minimum": 1, "maximum": 100000, "description": "Seats, a whole number. Between 1 and 100000." }, "monthlyVolume": { "type": "integer", "minimum": 0, "maximum": 1000000000, "description": "Monthly volume, a whole number. Between 0 and 1000000000." } } } }, "description": "Input payload for SaaS Pricing & Competitor Battlecard Spy. Required fields: `ourProductDescription`, `competitorUrls`. Optional fields: `scenario`.", "externalDocs": { "url": "https://writerslogic.com/agents/competitor-battlecard.json", "description": "Machine-readable record for SaaS Pricing & Competitor Battlecard Spy: the full input and result JSON Schemas, an example payload and the OpenAPI operation." } }, "examples": { "default": { "summary": "Example request for SaaS Pricing & Competitor Battlecard Spy", "description": "A complete valid request body for Competitor Pricing Battlecard.", "value": { "ourProductDescription": "Acme Support is an AI-first help desk with usage-based pricing ($0.40 per resolved ticket), SSO on every plan, and native Slack and Shopify integrations.", "competitorUrls": [ "https://www.zendesk.com", "https://www.intercom.com", "https://www.freshworks.com/freshdesk/" ] } } } } }, "description": "JSON request body for SaaS Pricing & Competitor Battlecard Spy. Required fields: `ourProductDescription`, `competitorUrls`. Optional fields: `scenario`. Unknown fields are rejected with a 400." }, "responses": { "200": { "description": "Success. `data` holds the answer and `_provenance` holds the signed credential for it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "our_positioning", "competitors", "talk_track", "evidence_gaps", "status", "headline", "confidence", "next_steps", "missing", "elapsedMs", "pricing_comparison", "pricing_scenario", "priceVerification", "pricingEvidence", "pagesScraped", "fetchFailures", "generatedAt" ], "properties": { "our_positioning": { "type": "string", "description": "Our positioning." }, "competitors": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "name", "url", "positioning", "target_segment", "pricing_model", "pricing_tiers", "hidden_fees_and_limits", "enterprise_upsell_triggers", "strengths", "weaknesses", "landmine_questions", "objection_handling", "wedge_features" ], "properties": { "name": { "type": "string", "description": "Name." }, "url": { "type": "string", "description": "URL." }, "positioning": { "type": "string", "description": "Their core claim, paraphrasing their own copy." }, "target_segment": { "type": "string", "description": "Target segment." }, "pricing_model": { "type": "string", "description": "e.g. per seat, usage-based, flat tiers, contact sales. \"not published\" if absent." }, "pricing_tiers": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "tier", "price", "billing", "key_limits", "notable_features" ], "properties": { "tier": { "type": "string", "description": "Tier." }, "price": { "type": "string", "description": "One amount exactly as shown on the page (e.g. \"$55 per agent/month\"), or \"not listed\". Put discounts, annual-vs-monthly differences and other amounts in notable_features, not here." }, "billing": { "type": "string", "description": "Billing." }, "key_limits": { "type": "array", "items": { "type": "string" }, "description": "Key limits, a list of strings." }, "notable_features": { "type": "array", "items": { "type": "string" }, "description": "Notable features, a list of strings." } } }, "description": "Pricing tiers, a list of objects." }, "hidden_fees_and_limits": { "type": "array", "items": { "type": "string" }, "description": "Hidden fees and limits, a list of strings." }, "enterprise_upsell_triggers": { "type": "array", "items": { "type": "string" }, "description": "Features or limits that force an upgrade (SSO, audit logs, seat caps...)." }, "strengths": { "type": "array", "items": { "type": "string" }, "description": "Strengths, a list of strings." }, "weaknesses": { "type": "array", "items": { "type": "string" }, "description": "Weaknesses, a list of strings." }, "landmine_questions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "question", "exposes" ], "properties": { "question": { "type": "string", "description": "Question." }, "exposes": { "type": "string", "description": "Exposes." } } }, "description": "Landmine questions, a list of objects." }, "objection_handling": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "objection", "response" ], "properties": { "objection": { "type": "string", "description": "Objection." }, "response": { "type": "string", "description": "Response." } } }, "description": "Objection handling, a list of objects." }, "wedge_features": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "feature", "why_we_win" ], "properties": { "feature": { "type": "string", "description": "Feature." }, "why_we_win": { "type": "string", "description": "Why we win." } } }, "description": "Wedge features, a list of objects." } } }, "description": "Competitors, a list of objects." }, "talk_track": { "type": "string", "description": "A 3-5 sentence opener for a live deal against these competitors." }, "evidence_gaps": { "type": "array", "items": { "type": "string" }, "description": "What could not be verified from the scraped pages." }, "pricing_comparison": { "type": "string", "description": "Computed in code from prices verified on the scraped pages; the model does not write it." }, "pricing_scenario": { "type": "object", "description": "Monthly and annual cost per verified tier at the scenario. assumed is true when no scenario was given and 10 seats / 1,000 monthly units were used." }, "status": { "type": "string", "enum": [ "complete", "partial" ], "description": "partial when a fetch or model step failed; missing lists what." }, "headline": { "type": "string", "description": "One-paragraph verdict: competitors analyzed, pricing published, verified-tier count, lowest verified cost at the scenario." }, "confidence": { "type": "string", "enum": [ "high", "medium", "low" ], "description": "high only when every priced tier was verified against the page and nothing is missing." }, "next_steps": { "type": "array", "items": { "type": "string" }, "description": "Next steps, a list of strings." }, "missing": { "type": "array", "items": { "type": "string" }, "description": "Sections that could not be produced (failed fetches or model steps); empty when status is complete." }, "elapsedMs": { "type": "integer", "description": "Elapsed ms, a whole number." }, "priceVerification": { "type": "array", "items": { "type": "object" }, "description": "Per model-written tier: verified | unverified | no_amount against the scraped text." }, "pricingEvidence": { "type": "array", "items": { "type": "object" }, "description": "Per competitor: whether any price or structured offer was found (pricingPublished)." }, "pagesScraped": { "type": "array", "items": { "type": "string" }, "description": "Pages scraped, a list of strings." }, "fetchFailures": { "type": "array", "items": { "type": "object" }, "description": "Fetch failures, a list of objects." }, "generatedAt": { "type": "string", "description": "Generated at." } }, "description": "Data, an object." }, "_provenance": { "type": "object", "description": "C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance" } }, "required": [ "data", "_provenance" ] }, "example": { "data": { "status": "complete", "headline": "3 competitors analyzed; pricing published for 3; 11 of 11 priced tiers verified on the page. Lowest verified cost at the scenario: Zendesk Support Team, USD 190/month. Ours at the scenario: USD 400/month.", "confidence": "high", "next_steps": [ "Use the landmine questions and talk_track in the first call; confirm any claim marked in evidence_gaps with the prospect." ], "missing": [], "our_positioning": "Acme Support is an AI-first help desk priced per resolved ticket at $0.40, so cost tracks outcomes rather than headcount or a stack of metered add-ons. SSO is included on every plan and native Slack and Shopify integrations ship in the product. Lead with predictable, outcome-based cost and securi...", "competitors": [ { "name": "Zendesk", "url": "https://www.zendesk.com/", "positioning": "An AI-first customer service platform where self-learning AI agents resolve issues end-to-end, claiming up to 80% automation across channels.", "target_segment": "Support teams from startups to large enterprises, with heavy emphasis on AI-driven automation and enterprise/contact-center buyers.", "pricing_model": "Primarily seat-based (per agent, per month) with plan tiers; enterprise plans are sales-assisted, and some AI and add-on usage appears metered.", "pricing_tiers": [ { "tier": "Support Team", "price": "$19 agent/month paid yearly", "billing": "Paid yearly (per agent)", "key_limits": [ "Per-agent seat pricing" ], "notable_features": [ "Email and ticketing system", "Prebuilt analytics dashboards", "Pre-written responses" ] }, { "tier": "Suite Team", "price": "$55 agent/month paid yearly", "billing": "Paid yearly (per agent)", "key_limits": [ "Per-agent seat pricing" ], "notable_features": [ "Support Team features plus messaging and live chat", "Positioned for unifying channels and automating resolutions with AI Agents" ] }, { "tier": "Suite Professional", "price": "$115 agent/month paid yearly", "billing": "Paid yearly (per agent)", "key_limits": [ "Per-agent seat pricing" ], "notable_features": [ "Suite Team features plus advanced automation and AI-driven insights", "Skills-based routing and AI-powered reporting" ] } ], "hidden_fees_and_limits": [ "Quoted prices are per agent and 'paid yearly', so the monthly-billing price is not shown.", "Pricing is primarily seat-based, so cost scales with headcount.", "Add-ons beyond Copilot require contacting sales." ], "enterprise_upsell_triggers": [ "Advanced security and governance are positioned in the Enterprise tier.", "Enterprise plans cannot be assumed to be purchasable online; they are sales-assisted.", "Generative AI for Voice and the full Copilot are listed under Suite Enterprise + Copilot." ], "strengths": [ "Broad platform covering ticketing, voice, messaging, QA, workforce management and ITSM.", "Large ecosystem with 1,800+ marketplace apps and support for 80+ languages.", "Strong market credibility, including a Gartner Magic Quadrant Leader claim and 22,000+ service teams on its AI." ], "weaknesses": [ "Seat-based pricing means cost grows with headcount rather than with outcomes.", "The Enterprise price is not published and requires a sales conversation.", "Several metered items (actions, MAUs, notifications, automated resolutions) make total cost harder to predict." ], "landmine_questions": [ { "question": "How do you expect your cost to change if ticket volume doubles but your team size stays flat, or the reverse?", "exposes": "Seat-based pricing ties cost to agent count rather than resolved volume." }, { "question": "Have you mapped out the metered items beyond seats, such as actions, active users, notifications and automated resolutions?", "exposes": "The pricing page lists caps and overage packs, such as $200 per 100K actions and $50 per MAU pack." }, { "question": "What security features such as SSO do you need on day one, and which plan does your vendor require for them?", "exposes": "Security and governance are positioned in the top Enterprise tier, and the SSO plan is not verified." } ], "objection_handling": [ { "objection": "Zendesk says its AI agents automate up to 80% of interactions.", "response": "We are AI-first too, and we charge $0.40 per resolved ticket, so you pay for outcomes rather than seats." }, { "objection": "Zendesk has 1,800+ marketplace apps and integrations.", "response": "We offer native Slack and Shopify integrations, so core workflows work out of the box. Confirm which integrations you need and map them in the evaluation." }, { "objection": "Zendesk offers enterprise-grade security and governance.", "response": "SSO is included on every Acme Support plan, so you do not need to upgrade to get it." } ], "wedge_features": [ { "feature": "Usage-based pricing at $0.40 per resolved ticket", "why_we_win": "Cost tracks resolved tickets rather than per-agent seats ($19 to $115 per agent/month paid yearly), which is simpler and more predictable." }, { "feature": "SSO on every plan", "why_we_win": "We do not gate SSO behind a higher tier, while Zendesk positions security and governance in its Enterprise plan." }, { "feature": "Native Slack and Shopify integrations", "why_we_win": "They are first-party in our product, whereas the Zendesk pages scraped do not show native versions of them." } ] }, { "name": "Intercom", "url": "https://www.intercom.com/", "positioning": "A complete system for human and AI customer service: the only helpdesk with a natively integrated AI Agent (Fin), so every conversation improves the next.", "target_segment": "Startups, small businesses and enterprise support teams that want one platform for AI and human support.", "pricing_model": "Hybrid: per-seat plans (Essential, Advanced, Expert) plus usage-based charges (Fin at $0.99 per outcome, messaging channels, add-ons).", "pricing_tiers": [ { "tier": "Essential", "price": "$29 per seat/month", "billing": "Monthly or annual self-serve; the page toggles Billed annually / Billed monthly", "key_limits": [ "Full seats are paid and required for teammates who interact with customers" ], "notable_features": [ "Shared inbox and ticketing", "Includes Fin AI Agent access", "Page also shows '$29 $19 per seat/mo' (likely annual vs monthly, not confirmed)" ] }, { "tier": "Advanced", "price": "$99 per seat/month", "billing": "Monthly or annual self-serve", "key_limits": [ "Includes 20 free Lite seats", "Lite seats are limited to internal collaboration" ], "notable_features": [ "Multiple team inboxes", "Workflows automation builder", "Round robin assignment" ] }, { "tier": "Expert", "price": "$139 per seat/month", "billing": "Annual or monthly; contract optional, but needed for Premier Support or custom terms", "key_limits": [ "Includes 50 free Lite seats" ], "notable_features": [ "SSO & identity management", "Service level agreements (SLAs)", "Multibrand Messenger / Help Center" ] } ], "hidden_fees_and_limits": [ "Fin costs $0.99 per outcome on top of per-seat fees.", "An outcome also counts when a customer simply doesn't ask for more help after Fin responds.", "Fin on an existing helpdesk carries a minimum monthly commitment (e.g. 50 outcomes)." ], "enterprise_upsell_triggers": [ "SSO & identity management appears only in the Expert tier.", "SLAs and multibrand Messenger/Help Center are Expert-tier features.", "Premier Support, onboarding and custom terms require a contract." ], "strengths": [ "Helpdesk and AI agent are natively integrated in one inbox and knowledge base.", "Claims Fin averages a 76% resolution rate across 12,000+ customers (vendor claim).", "Fin deploys across phone, email, chat and Slack, and integrates with Slack, Shopify and Github." ], "weaknesses": [ "Customers pay twice: per seat plus per Fin outcome, plus add-ons, which makes total cost harder to forecast.", "SSO is gated to the top Expert tier.", "Outcome definition can bill for conversations without a confirmed resolution." ], "landmine_questions": [ { "question": "How many teammates need to handle customer conversations, and how do you want AI costs to scale as volume grows?", "exposes": "Per-seat Full-seat fees plus $0.99 per Fin outcome mean cost scales with both headcount and AI volume." }, { "question": "Do you need SSO or identity management for your team, and from which day?", "exposes": "SSO & identity management appears only at the Expert tier." }, { "question": "How do you want to define a successful AI resolution for billing purposes?", "exposes": "Intercom counts an outcome when a customer doesn't ask for more help, not only on confirmed resolution." } ], "objection_handling": [ { "objection": "Intercom says Fin averages a 76% resolution rate across 12,000+ customers.", "response": "That is a vendor-reported average. We suggest a pilot on your own tickets, where Acme Support's $0.40 per resolved ticket ties cost to resolved tickets." }, { "objection": "Intercom is one complete system for AI and human support, so why switch?", "response": "Acme Support is also an AI-first help desk, with native Slack and Shopify integrations. Its usage-based pricing avoids stacking seat tiers, add-ons and outcome fees." }, { "objection": "Intercom's pricing looks transparent and starts at $29 per seat.", "response": "The seat price is only one component. Fin outcomes, messaging channels and add-ons are billed on top, and SSO needs the Expert tier, whereas Acme includes SSO on every plan." } ], "wedge_features": [ { "feature": "SSO on every plan", "why_we_win": "Intercom lists SSO & identity management only at the Expert tier, while Acme includes it on every plan." }, { "feature": "Simple usage-based pricing at $0.40 per resolved ticket", "why_we_win": "Intercom combines seat fees, $0.99 per outcome and separately priced add-ons, so Acme's single usage metric is easier to forecast." }, { "feature": "Native Slack and Shopify integrations", "why_we_win": "Intercom also lists Slack and Shopify, so this is parity rather than a wedge; use it to remove an objection, not to differentiate." } ] }, { "name": "Freshdesk (Freshworks)", "url": "https://www.freshworks.com/freshdesk/", "positioning": "AI-powered customer service software that combines ready-to-use AI, people and workflows, with a guided path from a first AI agent to AI across all of customer service.", "target_segment": "Support teams from small to enterprise, moving step by step toward AI-driven service with per-agent seats. The page also cites 50,000+ and 74,000+ businesses and a G2 Enterprise report.", "pricing_model": "Per agent per month, billed annually, plus metered AI and usage add-ons (AI sessions, day passes, connector tasks, MCP actions, Copilot).", "pricing_tiers": [ { "tier": "Growth", "price": "$19/agent/month, billed annually", "billing": "Annual, per agent", "key_limits": [ "First 500 Freddy AI Agent sessions included, limited to once per account", "Extra AI Agent sessions cost $49/100 sessions" ], "notable_features": [ "Ticketing and shared inbox", "Customer portal and knowledge base", "Out-of-the-box analytics and reporting" ] }, { "tier": "Pro (Most popular)", "price": "$55/agent/month, billed annually", "billing": "Annual, per agent", "key_limits": [ "Freddy AI Copilot is an extra $29/agent/month", "Day passes at $7/pass" ], "notable_features": [ "Multilingual helpdesk", "Custom dashboards and reporting", "Multiple SLA policies" ] }, { "tier": "Enterprise", "price": "$89/agent/month, billed annually", "billing": "Annual, per agent", "key_limits": [ "Day passes at $12/pass" ], "notable_features": [ "Access to all AI and helpdesk features", "Allowed domains and IP whitelisting" ] } ], "hidden_fees_and_limits": [ "Prices are shown as billed annually; no monthly price appears on the scraped page.", "The 500 free AI Agent sessions are once per account, then $49/100 sessions.", "Freddy AI Copilot costs an extra $29/agent/month." ], "enterprise_upsell_triggers": [ "Allowed domains and IP whitelisting are listed only under Enterprise.", "Multilingual, custom dashboards, multiple SLA policies and external collaborators are listed from Pro up.", "Exhausting the 500 free AI sessions forces paid session purchases." ], "strengths": [ "The entry price is low, at $19/agent/month on Growth.", "It has broad brand reach, citing 50,000+ and 74,000+ businesses and a G2 adoption recognition.", "It offers omnichannel ticketing, a knowledge base, a shared inbox and SLA tooling." ], "weaknesses": [ "Cost is hard to predict because seats are combined with metered AI sessions, tasks, actions and day passes.", "AI Copilot is an extra per-agent fee on top of the plan.", "The 'up to 80%' resolution claim is generic and unsubstantiated on the page." ], "landmine_questions": [ { "question": "How many AI-handled conversations do you expect per month, and how do you want to budget for them as volume grows?", "exposes": "AI Agent sessions are limited to 500 free per account, then $49/100 sessions, so AI costs scale on top of seat fees." }, { "question": "Do you need AI assistance for every agent, or only some?", "exposes": "Freddy AI Copilot is an additional $29/agent/month on top of plan pricing." }, { "question": "Which security controls, such as SSO and IP restrictions, must be in place for your team, and on which plan tier?", "exposes": "IP whitelisting appears only at Enterprise ($89/agent), and SSO placement is not shown on the scraped pages." } ], "objection_handling": [ { "objection": "Freshdesk starts at only $19/agent/month, so it is cheaper.", "response": "That is a seat price before AI usage. Acme charges $0.40 per resolved ticket, so you pay for outcomes rather than seats plus metered AI sessions, Copilot and add-ons." }, { "objection": "Freshdesk claims up to 80% AI resolution rates.", "response": "Ask for results on tickets like yours. With Acme's AI-first design and per-resolution pricing, cost tracks tickets actually resolved." }, { "objection": "Freshdesk has a large customer base and a G2 recognition.", "response": "Popularity does not equal fit. Acme offers SSO on every plan and native Slack and Shopify integrations, which matter for day-to-day workflows." } ], "wedge_features": [ { "feature": "Usage-based pricing at $0.40 per resolved ticket", "why_we_win": "Freshdesk combines per-agent seats with metered AI sessions, Copilot and other add-ons, while Acme ties cost to resolved tickets." }, { "feature": "SSO on every plan", "why_we_win": "Freshdesk's scraped pricing lists only IP whitelisting under Enterprise and does not show SSO; Acme includes SSO on every plan." }, { "feature": "Native Slack and Shopify integrations", "why_we_win": "Freshdesk's pages mention connecting business apps but name no Slack or Shopify integration, whereas Acme has both natively." } ] } ], "talk_track": "Thanks for walking us through your team's setup. The main thing we hear from teams like yours is that seat-based and metered pricing makes the bill hard to forecast as headcount and volume grow. Acme charges $0.40 per resolved ticket, so your cost follows the work that actually gets resolved. SSO...", "evidence_gaps": [ "The Suite Enterprise + Copilot price is not shown on the scraped pages.", "The $50, $83, $149, $1.50 and $2.00 figures appear on the pricing page without clear tier or product attribution, so they are not assigned to any tier.", "Whether SSO/SAML or audit logs are gated to a specific plan was not verifiable." ], "priceVerification": [ { "competitor": "Zendesk", "tier": "Support Team", "price": "$19 agent/month paid yearly", "status": "verified" }, { "competitor": "Zendesk", "tier": "Suite Team", "price": "$55 agent/month paid yearly", "status": "verified" }, { "competitor": "Zendesk", "tier": "Suite Professional", "price": "$115 agent/month paid yearly", "status": "verified" } ], "pricing_comparison": "Ours: USD 0.4 per unit = USD 400/month at the scenario.\nZendesk / Support Team: $19 agent/month paid yearly = USD 190/month at the scenario.\nZendesk / Suite Team: $55 agent/month paid yearly = USD 550/month at the scenario.\nZendesk / Suite Professional: $115 agent/month paid yearly = USD 1150/mon...", "pricing_scenario": { "seats": 10, "monthlyVolume": 1000, "ours": { "monthly": 400, "annual": 4800, "currency": "USD" }, "competitors": [ { "competitor": "Zendesk", "tier": "Support Team", "monthly": 190, "annual": 2280, "currency": "USD" }, { "competitor": "Zendesk", "tier": "Suite Team", "monthly": 550, "annual": 6600, "currency": "USD" }, { "competitor": "Zendesk", "tier": "Suite Professional", "monthly": 1150, "annual": 13800, "currency": "USD" } ], "assumed": true }, "pricingEvidence": [ { "url": "https://www.zendesk.com/", "pricingPageScraped": true, "pricesFound": 17, "structuredOffers": 0, "pricingPublished": true }, { "url": "https://www.intercom.com/", "pricingPageScraped": true, "pricesFound": 20, "structuredOffers": 6, "pricingPublished": true }, { "url": "https://www.freshworks.com/freshdesk/", "pricingPageScraped": true, "pricesFound": 23, "structuredOffers": 0, "pricingPublished": true } ], "pagesScraped": [ "https://www.zendesk.com/", "https://www.zendesk.com/pricing/", "https://www.intercom.com/" ], "fetchFailures": [], "elapsedMs": 36343, "generatedAt": "2026-11-06T17:56:39.311Z" }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:04d6181d-97ce-4fe9-8729-34da613e69b6", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "SaaS Pricing & Competitor Battlecard Spy", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T17:56:39.311Z", "softwareAgent": { "name": "writerslogic-agent-hub/competitor-battlecard", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/competitor-battlecard", "inputDigest": { "alg": "sha256", "hash": "0be2021415ce37736505be3936b301ae4f5e258cb03da456aa5be8b957e56431", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "e05798d470bd334526fa26e16532e11dd7e7e7386ed18ed11e32a8b45f00f2bb", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://www.zendesk.com/", "format": "text/html", "relationship": "inputTo", "dc": { "source": "https://www.zendesk.com/", "date": "2026-11-06T17:56:02.991Z" }, "hash": { "alg": "sha256", "hash": "acb665457d4315ab07292a6ce15d95ab8f827ff548730400d4458d0034b40e5b", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:e7e946bd-16f5-481f-8c19-69cd58968270", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T17:56:39.311Z", "credentialSubject": { "id": "urn:sha256:e05798d470bd334526fa26e16532e11dd7e7e7386ed18ed11e32a8b45f00f2bb", "agent": "competitor-battlecard", "endpoint": "POST /api/v1/competitor-battlecard", "outputDigest": { "alg": "sha256", "value": "e05798d470bd334526fa26e16532e11dd7e7e7386ed18ed11e32a8b45f00f2bb", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "0be2021415ce37736505be3936b301ae4f5e258cb03da456aa5be8b957e56431", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "c5991164cd08e7d8418ccb64a2f0a938eb2c6414ecffc7be8057bbec35eaf006", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://www.zendesk.com/", "sha256": "acb665457d4315ab07292a6ce15d95ab8f827ff548730400d4458d0034b40e5b" }, { "url": "https://www.freshworks.com/freshdesk/", "sha256": "6ff56c8396f628e932a9dd85330b5b8b9e3f4e30a2111c010378166be97ba908" }, { "url": "https://www.freshworks.com/pricing/", "sha256": "9d9d4279439fe6e0281834642d2db31be4a0c657d9aa2df74d85a85db899230b" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T17:56:39.311Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z5pctszqx3h9wvQpBXRx6CYDLXsekXioWK7GJZ2DqMfzG7kcJu7eSwQkRG7WFiNMzLiNSZii8UyuEJDgJtG71j9do" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:5d303a1959471e2d5def037df4fd149f0999d0968d344ff07d44dfa5d7923af3", "signature": "0x7e01fc509976072bc8c3f5eaa1b38437e898b832c59527ddcb4ce9a511c237c502012beef325e1e558da193f3b2df83fbc1153c8e34fefd0b7d8dc05d18978051c" } } } } } }, "400": { "description": "Invalid request. The `error` field names the offending field and `code` is `invalid_request`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "401": { "description": "Missing or invalid RapidAPI key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } }, "402": { "description": "Payment required. The request did not arrive through RapidAPI.", "content": { "application/json": { "schema": { "type": "object", "description": "x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)", "properties": { "x402Version": { "type": "integer" }, "error": { "type": "string" }, "code": { "type": "string" }, "resource": { "type": "object" }, "accepts": { "type": "array", "items": { "type": "object" } }, "extensions": { "type": "object" } } } } } }, "502": { "description": "A source or model this endpoint depends on failed. Retry later; the body carries an `error` message and a `code`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" } } } } } } }, "externalDocs": { "url": "https://writerslogic.com/agents/competitor-battlecard/", "description": "Documentation for SaaS Pricing & Competitor Battlecard Spy: what it does, every input and result field, an example call and the response shape. A free signed sample response is linked from the page." }, "x-tests": [ { "name": "competitor-battlecard: unknown field is rejected", "method": "POST", "path": "/v1/competitor-battlecard", "body": { "nonsense": true }, "assert": { "status": 400, "json": { "code": "invalid_request" }, "maxMs": 10000 } }, { "name": "competitor-battlecard: example returns a signed result", "method": "POST", "path": "/v1/competitor-battlecard", "body": { "ourProductDescription": "Acme Support is an AI-first help desk with usage-based pricing ($0.40 per resolved ticket), SSO on every plan, and native Slack and Shopify integrations.", "competitorUrls": [ "https://www.zendesk.com", "https://www.intercom.com", "https://www.freshworks.com/freshdesk/" ] }, "assert": { "status": 200, "jsonPathsExist": [ "data", "_provenance.credential" ], "jsonSchema": { "type": "object", "properties": { "data": { "type": "object", "required": [ "our_positioning", "competitors", "talk_track", "evidence_gaps", "status", "headline", "confidence", "next_steps", "missing", "elapsedMs", "pricing_comparison", "pricing_scenario", "priceVerification", "pricingEvidence", "pagesScraped", "fetchFailures", "generatedAt" ], "properties": { "our_positioning": { "type": "string" }, "competitors": { "type": "array", "items": { "type": "object", "required": [ "name", "url", "positioning", "target_segment", "pricing_model", "pricing_tiers", "hidden_fees_and_limits", "enterprise_upsell_triggers", "strengths", "weaknesses", "landmine_questions", "objection_handling", "wedge_features" ], "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "positioning": { "type": "string" }, "target_segment": { "type": "string" }, "pricing_model": { "type": "string" }, "pricing_tiers": { "type": "array", "items": { "type": "object", "required": [ "tier", "price", "billing", "key_limits", "notable_features" ], "properties": { "tier": { "type": "string" }, "price": { "type": "string" }, "billing": { "type": "string" }, "key_limits": { "type": "array", "items": { "type": "string" } }, "notable_features": { "type": "array", "items": { "type": "string" } } } } }, "hidden_fees_and_limits": { "type": "array", "items": { "type": "string" } }, "enterprise_upsell_triggers": { "type": "array", "items": { "type": "string" } }, "strengths": { "type": "array", "items": { "type": "string" } }, "weaknesses": { "type": "array", "items": { "type": "string" } }, "landmine_questions": { "type": "array", "items": { "type": "object", "required": [ "question", "exposes" ], "properties": { "question": { "type": "string" }, "exposes": { "type": "string" } } } }, "objection_handling": { "type": "array", "items": { "type": "object", "required": [ "objection", "response" ], "properties": { "objection": { "type": "string" }, "response": { "type": "string" } } } }, "wedge_features": { "type": "array", "items": { "type": "object", "required": [ "feature", "why_we_win" ], "properties": { "feature": { "type": "string" }, "why_we_win": { "type": "string" } } } } } } }, "talk_track": { "type": "string" }, "evidence_gaps": { "type": "array", "items": { "type": "string" } }, "pricing_comparison": { "type": "string" }, "pricing_scenario": { "type": "object" }, "status": { "type": "string", "enum": [ "complete", "partial" ] }, "headline": { "type": "string" }, "confidence": { "type": "string", "enum": [ "high", "medium", "low" ] }, "next_steps": { "type": "array", "items": { "type": "string" } }, "missing": { "type": "array", "items": { "type": "string" } }, "elapsedMs": { "type": "integer" }, "priceVerification": { "type": "array", "items": { "type": "object" } }, "pricingEvidence": { "type": "array", "items": { "type": "object" } }, "pagesScraped": { "type": "array", "items": { "type": "string" } }, "fetchFailures": { "type": "array", "items": { "type": "object" } }, "generatedAt": { "type": "string" } } }, "_provenance": { "type": "object" } }, "required": [ "data", "_provenance" ] }, "maxMs": 120000 } } ] } }, "/v1/verify-provenance": { "post": { "operationId": "verifyProvenance", "summary": "Verify a Signed Result", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "The `data` field of the response being verified, unchanged." }, "_provenance": { "type": "object", "description": "The `_provenance` field of the same response, unchanged." } }, "required": [ "data", "_provenance" ] }, "examples": { "A signed response": { "summary": "A signed response", "value": { "data": { "url": "https://example.com/", "final_url": "https://example.com/", "title": "Example Domain", "canonical": null, "lang": "en", "description": null, "format": "markdown", "content": "This domain is for use in documentation examples without needing permission. This is not a service; avoid relying on it for testing and monitoring purposes.", "word_count": 25, "truncated": false, "content_sha256": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f", "html_sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "links": [], "fetched_at": "2026-11-06T17:55:19.431Z", "limits": { "note": "no JavaScript rendering; one request; robots.txt not consulted" } }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:54fac44f-12e7-4547-a4ea-e892f4623ca6", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Page contents: URL to clean Markdown or text", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T17:55:19.443Z", "softwareAgent": { "name": "writerslogic-agent-hub/page-contents", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/page-contents", "inputDigest": { "alg": "sha256", "hash": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://example.com/", "format": "text/html", "relationship": "inputTo", "dc": { "source": "https://example.com/", "date": "2026-11-06T17:55:19.443Z" }, "hash": { "alg": "sha256", "hash": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:33216a77-d024-472f-ba4d-13438a2bf6ba", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T17:55:19.443Z", "credentialSubject": { "id": "urn:sha256:d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "agent": "page-contents", "endpoint": "POST /api/v1/page-contents", "outputDigest": { "alg": "sha256", "value": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "b33ed80ac42f39ddcd72d0af27c6774f62350e93e3265b2d1bca01c0d71c584a", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://example.com/", "sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T17:55:19.443Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z2AtwZQqTStnrRzCnCohybJ3cwRpsc52hhweLLPbdcHLTn7XXyD9sVRWD61uSpUsfJ88qSePKYKXyHT3vjxq4MtSZ" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:153a58f215a0314d9fa994f7ab88cece46f678cca7e6f1628dab0638becfdbc4", "signature": "0x9c165b64d61abe9a39a0f131729fd98bb9059c9e22ac5d7df3499730b4efbe4d45f81df06f69e06888d4d80f2bb823857fcb52a4dc208ab7d37c02158bc65a621c" } } } }, "A tampered copy": { "summary": "A tampered copy (valid is false)", "value": { "data": { "url": "https://example.com/", "final_url": "https://example.com/", "title": "Example Domain", "canonical": null, "lang": "en", "description": null, "format": "markdown", "content": "This domain is for use in documentation examples without needing permission. This is not a service; avoid relying on it for testing and monitoring purposes.", "word_count": 25, "truncated": false, "content_sha256": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f", "html_sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "links": [], "fetched_at": "2026-11-06T17:55:19.431Z", "limits": { "note": "no JavaScript rendering; one request; robots.txt not consulted" }, "tampered": true }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:54fac44f-12e7-4547-a4ea-e892f4623ca6", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Page contents: URL to clean Markdown or text", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T17:55:19.443Z", "softwareAgent": { "name": "writerslogic-agent-hub/page-contents", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/page-contents", "inputDigest": { "alg": "sha256", "hash": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://example.com/", "format": "text/html", "relationship": "inputTo", "dc": { "source": "https://example.com/", "date": "2026-11-06T17:55:19.443Z" }, "hash": { "alg": "sha256", "hash": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:33216a77-d024-472f-ba4d-13438a2bf6ba", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T17:55:19.443Z", "credentialSubject": { "id": "urn:sha256:d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "agent": "page-contents", "endpoint": "POST /api/v1/page-contents", "outputDigest": { "alg": "sha256", "value": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "b33ed80ac42f39ddcd72d0af27c6774f62350e93e3265b2d1bca01c0d71c584a", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://example.com/", "sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T17:55:19.443Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z2AtwZQqTStnrRzCnCohybJ3cwRpsc52hhweLLPbdcHLTn7XXyD9sVRWD61uSpUsfJ88qSePKYKXyHT3vjxq4MtSZ" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:153a58f215a0314d9fa994f7ab88cece46f678cca7e6f1628dab0638becfdbc4", "signature": "0x9c165b64d61abe9a39a0f131729fd98bb9059c9e22ac5d7df3499730b4efbe4d45f81df06f69e06888d4d80f2bb823857fcb52a4dc208ab7d37c02158bc65a621c" } } } } } } }, "description": "The complete response body to verify, exactly as the endpoint returned it: both `data` and `_provenance`." }, "responses": { "200": { "description": "The verification result: `valid` is true when every check passes, and `checks` lists each check with its outcome.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "valid": true, "checks": [ { "check": "version", "ok": true, "detail": "writerslogic-provenance/1" }, { "check": "outputDigest", "ok": true, "detail": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46" }, { "check": "manifestDigest", "ok": true }, { "check": "c2pa.hash.data", "ok": true }, { "check": "proof", "ok": true }, { "check": "ethSignature", "ok": true, "detail": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f" } ] } } } } }, "description": "Checks the signed provenance envelope of any response from this API: structure, output and manifest digests, the Ed25519 credential proof and the Ethereum co-signature. Send the complete response body with its data and _provenance fields. It reads no outside source, so the result is the same on every call.", "x-tests": [ { "name": "verify: a signed sample verifies", "method": "POST", "path": "/v1/verify-provenance", "body": { "data": { "url": "https://example.com/", "final_url": "https://example.com/", "title": "Example Domain", "canonical": null, "lang": "en", "description": null, "format": "markdown", "content": "This domain is for use in documentation examples without needing permission. This is not a service; avoid relying on it for testing and monitoring purposes.", "word_count": 25, "truncated": false, "content_sha256": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f", "html_sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "links": [], "fetched_at": "2026-11-06T17:55:19.431Z", "limits": { "note": "no JavaScript rendering; one request; robots.txt not consulted" } }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:54fac44f-12e7-4547-a4ea-e892f4623ca6", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Page contents: URL to clean Markdown or text", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T17:55:19.443Z", "softwareAgent": { "name": "writerslogic-agent-hub/page-contents", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/page-contents", "inputDigest": { "alg": "sha256", "hash": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://example.com/", "format": "text/html", "relationship": "inputTo", "dc": { "source": "https://example.com/", "date": "2026-11-06T17:55:19.443Z" }, "hash": { "alg": "sha256", "hash": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:33216a77-d024-472f-ba4d-13438a2bf6ba", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T17:55:19.443Z", "credentialSubject": { "id": "urn:sha256:d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "agent": "page-contents", "endpoint": "POST /api/v1/page-contents", "outputDigest": { "alg": "sha256", "value": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "b33ed80ac42f39ddcd72d0af27c6774f62350e93e3265b2d1bca01c0d71c584a", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://example.com/", "sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T17:55:19.443Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z2AtwZQqTStnrRzCnCohybJ3cwRpsc52hhweLLPbdcHLTn7XXyD9sVRWD61uSpUsfJ88qSePKYKXyHT3vjxq4MtSZ" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:153a58f215a0314d9fa994f7ab88cece46f678cca7e6f1628dab0638becfdbc4", "signature": "0x9c165b64d61abe9a39a0f131729fd98bb9059c9e22ac5d7df3499730b4efbe4d45f81df06f69e06888d4d80f2bb823857fcb52a4dc208ab7d37c02158bc65a621c" } } }, "assert": { "status": 200, "json": { "valid": true }, "maxMs": 10000 } }, { "name": "verify: a tampered sample fails", "method": "POST", "path": "/v1/verify-provenance", "body": { "data": { "url": "https://example.com/", "final_url": "https://example.com/", "title": "Example Domain", "canonical": null, "lang": "en", "description": null, "format": "markdown", "content": "This domain is for use in documentation examples without needing permission. This is not a service; avoid relying on it for testing and monitoring purposes.", "word_count": 25, "truncated": false, "content_sha256": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f", "html_sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "links": [], "fetched_at": "2026-11-06T17:55:19.431Z", "limits": { "note": "no JavaScript rendering; one request; robots.txt not consulted" }, "tampered": true }, "_provenance": { "version": "writerslogic-provenance/1", "issuer": "did:web:agents.writerslogic.com", "verify": { "endpoint": "POST /api/v1/verify-provenance", "did": "did:web:agents.writerslogic.com" }, "manifest": { "format": "application/json", "instance_id": "xmp:iid:54fac44f-12e7-4547-a4ea-e892f4623ca6", "claim_generator_info": [ { "name": "WritersLogic x402 Agent Hub", "version": "2.0.0" } ], "title": "Page contents: URL to clean Markdown or text", "assertions": [ { "label": "c2pa.actions.v2", "data": { "actions": [ { "action": "c2pa.created", "when": "2026-11-06T17:55:19.443Z", "softwareAgent": { "name": "writerslogic-agent-hub/page-contents", "version": "2.0.0" }, "digitalSourceType": "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia", "parameters": { "endpoint": "POST /api/v1/page-contents", "inputDigest": { "alg": "sha256", "hash": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" } } } ] } }, { "label": "c2pa.hash.data", "data": { "alg": "sha256", "hash": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "name": "jcs-canonical-json(data)" } }, { "label": "c2pa.ingredient.v3", "data": { "title": "https://example.com/", "format": "text/html", "relationship": "inputTo", "dc": { "source": "https://example.com/", "date": "2026-11-06T17:55:19.443Z" }, "hash": { "alg": "sha256", "hash": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484", "basis": "body" } } } ] }, "credential": { "@context": [ "https://www.w3.org/ns/credentials/v2" ], "id": "urn:uuid:33216a77-d024-472f-ba4d-13438a2bf6ba", "type": [ "VerifiableCredential", "AgentOutputCredential" ], "issuer": "did:web:agents.writerslogic.com", "validFrom": "2026-11-06T17:55:19.443Z", "credentialSubject": { "id": "urn:sha256:d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "agent": "page-contents", "endpoint": "POST /api/v1/page-contents", "outputDigest": { "alg": "sha256", "value": "d4afce90393123c0fc632209e39b5ae3a02b6a99f5392afaf8ed8999f52b9a46", "canonicalization": "JCS" }, "inputDigest": { "alg": "sha256", "value": "df2ac97223ac0478b6c6621d7c8a3d7bfe33037cfa1c47749c89100794df07ef", "canonicalization": "JCS" }, "manifestDigest": { "alg": "sha256", "value": "b33ed80ac42f39ddcd72d0af27c6774f62350e93e3265b2d1bca01c0d71c584a", "canonicalization": "JCS" }, "ingredients": [ { "url": "https://example.com/", "sha256": "25ddf2c883e0d1958ea971d279a7e4f0fd446724ee3db7db19dadabd4a62e484" } ], "payment": { "scheme": "api-key", "network": "eip155:8453", "payer": "sample" } }, "proof": { "type": "DataIntegrityProof", "cryptosuite": "eddsa-jcs-2022", "created": "2026-11-06T17:55:19.443Z", "verificationMethod": "did:web:agents.writerslogic.com#key-1", "proofPurpose": "assertionMethod", "proofValue": "z2AtwZQqTStnrRzCnCohybJ3cwRpsc52hhweLLPbdcHLTn7XXyD9sVRWD61uSpUsfJ88qSePKYKXyHT3vjxq4MtSZ" } }, "ethSignature": { "type": "EIP-191", "signer": "did:pkh:eip155:8453:0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "address": "0x3DBd42560cA7a7E448A2c7DfC9E785526189411f", "message": "writerslogic-provenance:153a58f215a0314d9fa994f7ab88cece46f678cca7e6f1628dab0638becfdbc4", "signature": "0x9c165b64d61abe9a39a0f131729fd98bb9059c9e22ac5d7df3499730b4efbe4d45f81df06f69e06888d4d80f2bb823857fcb52a4dc208ab7d37c02158bc65a621c" } } }, "assert": { "status": 200, "json": { "valid": false }, "maxMs": 10000 } } ], "externalDocs": { "url": "https://writerslogic.com/agents/", "description": "How the signed provenance envelope works, and the documentation index for every agent whose output it verifies." } } } }, "externalDocs": { "url": "https://writerslogic.com/agents/", "description": "Documentation for every WritersLogic agent: human-readable pages plus an index.json listing machine-readable records." }, "x-documentation": { "readme": " $\"WritersLogic$ \n\n## PII Redaction, Company Identity & Lead Research API\n\n**Redact. Resolve. Verify. Research.**\n\nData privacy and company intelligence behind one API: PII redaction with a built-in self-check, legal-entity resolution, credential verification, and lead research. Every successful response includes cryptographically signed provenance for independent integrity verification.\n\n## Quick Start\n\nSubscribe through RapidAPI, select an endpoint in the Playground, and run its example—or make a request directly.\n\n**Example: Redact personal data from text**\n\n```bash\ncurl -X POST \"https://$RAPIDAPI_HOST/v1/redact-text\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-RapidAPI-Key: $RAPIDAPI_KEY\" \\\n -H \"X-RapidAPI-Host: $RAPIDAPI_HOST\" \\\n -d '{\n \"text\": \"Patient: Maria Gonzalez, DOB 04/12/1980, SSN 123-45-6789. Reach her at maria.gonzalez@example.org or (555) 010-0199. Maria Gonzalez was seen at Acme Clinic, Inc.\",\n \"level\": 4,\n \"include\": [\n \"organization\"\n ],\n \"style\": \"label\"\n }'\n```\n\nAll endpoints accept `POST` requests with JSON bodies. Replace the environment variables with your RapidAPI host and API key.\n\n## Six Endpoints. One API.\n\n| Endpoint | Capability |\n|---|---|\n| **PII Redaction with Self-Check** | Redact personal data at four levels, then rescan the output as a self-check. |\n| **Company Identity Resolver (LEI, VAT, CIK)** | Resolve a name, domain, LEI, EU VAT number, SEC CIK, or ticker to one legal entity. |\n| **Open Badges Credential Verifier** | Verify Open Badges 2.0 and 3.0 credentials end to end. |\n| **B2B Lead Enrichment & Cold Email Draft** | Turn a company homepage into a value proposition, buyer persona, and a targeted cold email draft. |\n| **Competitor Pricing Battlecard** | Read up to three competitor sites and return a sales battlecard. |\n| **Verify a Signed Result** | Validate provenance digests, Ed25519 credential proofs, and Ethereum EIP-191 co-signatures. |\n\n## Every Result Comes with Proof\n\nMost APIs return data. **WritersLogic also returns cryptographic evidence of the result and its recorded sources.**\n\nEvery successful response includes:\n\n- **SHA-256 digests** to detect modifications.\n- **Source provenance** recording what was processed.\n- **Ed25519 signatures** to authenticate the signing identity.\n- **Independent verification** through public cryptographic credentials.\n\n**Simplified response:**\n\n```json\n{\n \"data\": {\n \"...\": \"Endpoint-specific result\"\n },\n \"_provenance\": {\n \"version\": \"writerslogic-provenance/1\",\n \"manifest\": {\n \"...\": \"Source records and SHA-256 digests\"\n },\n \"credential\": {\n \"...\": \"W3C Verifiable Credential\"\n },\n \"ethSignature\": {\n \"...\": \"EIP-191 co-signature\"\n }\n }\n}\n```\n\nA valid signature establishes integrity and signing-key authenticity—not the factual accuracy of the underlying source.\n\n

Cryptographic Verification & Technical Details

\n\n

Submit the complete response to the Verify a Signed Result endpoint to validate:

\n\n

Provenance envelope structure and version
Output and manifest SHA-256 digests
W3C Verifiable Credential and Ed25519 proof
Ethereum EIP-191 co-signature

\n\n

Publisher DID: did:web:agents.writerslogic.com

\n\n

Public DID document: View verification keys

\n\n

Results can also be verified independently using the published key material and applicable signature and canonicalization specifications.

\n\n

Changing the signed result or its covered metadata causes the corresponding digest or signature check to fail.

\n\n

\n\n## Built for Real-World Workflows\n\n**Privacy engineering** — Redact personal data before text reaches logs, models, or third parties.\n\n**KYB & vendor onboarding** — Resolve names, domains, LEIs, VAT numbers, and tickers to one legal entity.\n\n**Credential checking** — Verify Open Badges 2.0 and 3.0 credentials end to end.\n\n**Sales research** — Enrich leads from public homepages and build competitor pricing battlecards.\n\n

Limits, Security & Processing

\n\n

Scope: Redaction reports what it removed by category and position and never repeats the original values. Names and organizations are found heuristically.
Processing: Model-backed requests may take up to approximately 90 seconds. Configure timeouts of at least 120 seconds.
Input handling: Inputs are processed for the individual request and are not stored by the service.
Verification scope: Cryptographic proof establishes integrity, not independent factual correctness.

\n\n

Error Codes & Troubleshooting

\n\n

400 — Invalid request: Missing or invalid input. Inspect the error field.
401 — Unauthorized: Missing or invalid RapidAPI key.
402 — Payment required: Request not routed through RapidAPI.
502 — Upstream failure: Source or model processing failed. Retry with backoff.

\n\n

Example error:

\n\n

{\n  \"error\": \"$.text: required\",\n  \"code\": \"invalid_request\"\n}

\n\n

About WritersLogic

\n\n

Verifiable AI infrastructure. Proof, not promises.

\n\n

WritersLogic develops cryptographic infrastructure for AI agents, content provenance, and independently verifiable digital workflows.

\n\n

Full API documentation

\n\n

Public signing identity

\n\n

\n\n---\n\n**Ready to integrate?** Select an endpoint in the RapidAPI Playground and run your first signed request." } }