Skip to content
Fromenance docsFromenance docs

Overview

Fromenance API 1.0.0

Section titled “Fromenance API 1.0.0”

Communication provenance for banks, credit unions, insurers, and utilities. Register every outbound communication at send time; verify what customers forward or paste. Errors are RFC 9457 problem details. All timestamps are UTC ISO 8601. Cursor pagination with cursor and limit.

Operations

Section titled “ Operations ”
GET
/healthz
GET
/v1/communications
POST
/v1/communications
POST
/v1/communications/batch
POST
/v1/communications/reserve
GET
/v1/communications/{id}
PATCH
/v1/communications/{id}
POST
/v1/public/submit
GET
/v1/public/verdict/{token}
POST
/v1/leads
GET
/v1/submissions
GET
/v1/submissions/{id}
POST
/v1/submissions/{id}/override
GET
/v1/indicators
GET
/v1/fraud-list
POST
/v1/fraud-list
DELETE
/v1/fraud-list/{id}
GET
/v1/domains
POST
/v1/domains
GET
/v1/domains/{id}
DELETE
/v1/domains/{id}
PATCH
/v1/domains/{id}
POST
/v1/domains/{id}/check
POST
/v1/domains/{id}/reply-identity
POST
/v1/domains/{id}/reply-identity/verify
GET
/v1/domains/{id}/forwarding-test
POST
/v1/domains/{id}/forwarding-test
GET
/v1/sending-sources
POST
/v1/sending-sources
GET
/v1/sending-sources/{id}
DELETE
/v1/sending-sources/{id}
PATCH
/v1/sending-sources/{id}
POST
/v1/sending-sources/{id}/rotate-secret
POST
/v1/sending-sources/{id}/test-event
GET
/v1/reply-templates
PUT
/v1/reply-templates/{outcome}
POST
/v1/reply-templates/{outcome}/preview
POST
/v1/reply-templates/{outcome}/test
GET
/v1/webhook-endpoints
POST
/v1/webhook-endpoints
DELETE
/v1/webhook-endpoints/{id}
PATCH
/v1/webhook-endpoints/{id}
GET
/v1/webhook-endpoints/{id}/deliveries
POST
/v1/webhook-endpoints/{id}/deliveries/{delivery_id}/replay
POST
/v1/webhook-endpoints/{id}/test
GET
/v1/stats
GET
/v1/me
GET
/v1/tenant
PATCH
/v1/tenant
GET
/v1/users
POST
/v1/users
DELETE
/v1/users/{id}
PATCH
/v1/users/{id}
GET
/v1/api-keys
POST
/v1/api-keys
DELETE
/v1/api-keys/{id}
GET
/v1/audit
GET
/v1/site-keys
POST
/v1/site-keys
DELETE
/v1/site-keys/{id}
PATCH
/v1/site-keys/{id}
GET
/v1/search
GET
/v1/setup

Authentication

Section titled “ Authentication ”

ApiKey

Section titled “ApiKey”

Tenant API key with fr_live_ or fr_test_ prefix.

Security scheme type: http

SiteKey

Section titled “SiteKey”

Public site key for the verify widget. Bound to allowed origins.

Security scheme type: apiKey

Header parameter name: X-Site-Key

Session

Section titled “Session”

Admin app or backoffice session.

Security scheme type: apiKey

Cookie parameter name: fromenance.session_token