Overview
The B2B endpoint accepts a credential-free HTTP(S) URL, forwards it to the VerifyPulse verification engine, and returns a business-friendly result with a correlation ID. The output is decision-support information, not a guaranteed fraud verdict or a substitute for a client’s final action policy.
Before integrating: API access must be configured. Do not put a secret API key in browser code, public repositories, screenshots, or client-side mobile apps.
Authentication and request headers
| Header | Required | Purpose |
|---|---|---|
X-API-Key or Authorization: Bearer | Yes | Supplies the configured B2B API secret. |
X-VerifyPulse-Key-Id | Required when a scoped key registry is configured | Identifies the configured active key record for scope, tenant, and expiry checks. |
Content-Type: application/json | Yes | Declares a JSON request body. |
Browser-origin requests are accepted only when their origin is explicitly allow-listed. Server-to-server callers generally do not send an Origin header.
POST /api/v1/scan
Base URL: https://www.verify-pulse.com
| JSON field | Required | Description |
|---|---|---|
url | Yes | A credential-free HTTP(S) URL with a maximum length of 2,048 characters. |
Response fields
| Field | Meaning |
|---|---|
correlation_id | Request identifier used to help connect client-side and VerifyPulse operational records. |
status | The engine verdict, such as SAFE, SUSPICIOUS, DANGEROUS, or a verification-needed state. |
threat_level | Business-friendly LOW, MEDIUM, or HIGH mapping. |
scam_type | Best available classification; it can be Unknown. |
confidence | Input-specific confidence signal; it is not proof that a sender or transaction is authentic. |
message / action_steps | Available explanation and recommended safer next steps. |
Error behavior
| Status | Example meaning |
|---|---|
400 | Invalid or missing URL input. |
401 | Missing, invalid, expired, or revoked B2B API key. |
403 | Browser origin is not allowed, or the key does not have the required scan scope. |
429 | Request rate limit reached; retry according to response headers. |
502 | The master verification engine did not return a successful B2B result. |
503 | B2B authentication configuration is missing or invalid. |
Current integration limits
- This maintained B2B route currently documents URL scanning, not a blanket message/file/transaction API.
- Rate controls are a protective control, not a published capacity guarantee or uptime SLA.
- VerifyPulse should not be used as the only automatic payment-blocking input.
- Use the Status page and Risk Management page to understand observable service state and degraded-result behavior.
Access discussion
For a controlled pilot or API-access discussion, send the intended use case, expected daily URL volume, integration type, and whether the workflow is user-facing or agent-facing to narayanglokhande2007@gmail.com.