# Faro Api API

**Canonical:** https://apis.io/apis/farofinance-app/faro-api-api/  
**Provider:** Faro — https://apis.io/providers/farofinance-app/  
**Base URL:** https://api.farofinance.app  
**Documentation:** https://api.farofinance.app/openapi.json

Faro Api API is one of 2 APIs that [Faro](https://apis.io/providers/farofinance-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Faro returns **one consistent verdict** — 🟢 green, 🟡 yellow, or 🔴 red — for a

## Operations (54)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/pages/claims` | Start a page claim |
| POST | `/v1/pages/claims/{claim_id}/prove` | Prove control (soft auto-verifies on claim; strict checks DNS TXT) |
| GET | `/v1/pages/claims/{claim_id}/cloudflare/authorize` | Start Cloudflare OAuth for domain control (scaffold) |
| GET | `/v1/pages/cloudflare/callback` | Cloudflare OAuth callback (scaffold) |
| POST | `/v1/pages/claims/{claim_id}/cloudflare/verify` | Verify faro-verify TXT via DNS (Cloudflare DoH) |
| POST | `/v1/pages/claims/{claim_id}/checks` | Run sector registry checks via the verify engine |
| POST | `/v1/pages` | Publish a Faro page (consent) |
| GET | `/v1/pages` | List recently published pages |
| GET | `/v1/pages/{slug}` | Public page standing |
| POST | `/v1/agents` | Register a business agent |
| GET | `/v1/agents/{agent_id}` | Agent binding lookup |
| POST | `/v1/guard/checkout` | Checkout gate — payee + optional buyer agent |
| GET | `/v1/index` | Trust Index v0 aggregate |
| GET | `/v1/keepers/cohorts/current` | Active Keepers cohort |
| POST | `/v1/keepers/cohorts/{cohort_id}/join` | Join a Keepers cohort |
| GET | `/v1/club/{slug}/badge` | Live Club / Verified badge (SVG or JSON) |
| POST | `/v1/billing/entitlements` | Upsert billing entitlement (admin or billing webhook) |
| GET | `/v1/billing/entitlements` | List entitlements for email |
| GET | `/health` | Liveness check |
| POST | `/v1/verify/url` | Verify a URL |
| POST | `/v1/verify/payee` | Verify a payee |
| POST | `/v1/verify/message` | Verify a message |
| POST | `/v1/verify/document` | Verify a document |
| POST | `/v1/verify` | Verify any artifact |
| POST | `/v1/verify/payment-intent` | Verify a payment intent |
| POST | `/v1/verify/before-pay` | Verify before pay (protocol payload) |
| POST | `/v1/verify/batch` | Verify a batch of artifacts |
| GET | `/v1/verify/batch/{job_id}` | Poll an async batch job |
| POST | `/v1/reports` | Report a bad actor or wrong verdict |
| POST | `/v1/diligence` | Generate a cited diligence report |
| GET | `/v1/me/watch` | List watched artifacts |
| POST | `/v1/me/watch` | Watch an artifact for flag alerts |
| DELETE | `/v1/me/watch` | Remove an artifact watch |
| POST | `/v1/keys/request` | Request an API key by email |
| POST | `/v1/keys/confirm` | Confirm the magic link and receive the key |
| GET | `/v1/me` | Profile for the authenticated API key |
| GET | `/v1/me/usage` | Per-key call counts |
| GET | `/v1/me/verdicts` | Recent verdicts for this key |
| POST | `/v1/me/keys/test` | Issue a test (sandbox) key |
| GET | `/v1/me/webhooks` | List webhook endpoints |
| POST | `/v1/me/webhooks` | Register a webhook endpoint |
| DELETE | `/v1/me/webhooks/{endpoint_id}` | Delete a webhook endpoint |
| POST | `/v1/me/webhooks/{endpoint_id}/ping` | Send a test event |
| GET | `/v1/me/webhooks/{endpoint_id}/deliveries` | Recent delivery attempts |
| GET | `/.well-known/jwks.json` | Receipt-signing public keys (JWKS) |
| GET | `/.well-known/faro-log-roots` | Signed daily Merkle roots of the receipt log |
| GET | `/.well-known/faro-eas-schema` | Frozen Faro credential EAS schema (Base) |
| GET | `/v1/attestations` | Read the current Faro credential for a subject |
| GET | `/v1/receipts/{receipt_id}` | Fetch a trust receipt |
| GET | `/.well-known/credential-status/{list_id}` | Credential revocation status list |
| POST | `/v1/credentials` | Issue a Faro Verified credential (admin) |
| GET | `/v1/credentials/{credential_id}` | Fetch a Faro Verified credential |
| POST | `/v1/credentials/{credential_id}/verify` | Verify a credential (signature + revocation + subject binding) |
| POST | `/v1/credentials/{credential_id}/revoke` | Revoke a credential (admin) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/farofinance-app/openapi/_original/farofinance-app-api-openapi.json
- **JSONSchema** — https://artifacts.apis.io/farofinance-app/json-schema/farofinance-app-verdict-result-schema.json
- **JSONSchema** — https://artifacts.apis.io/farofinance-app/json-schema/farofinance-app-receipt-out-schema.json
- **JSONSchema** — https://artifacts.apis.io/farofinance-app/json-schema/farofinance-app-attestation-out-schema.json
- **JSONSchema** — https://artifacts.apis.io/farofinance-app/json-schema/farofinance-app-eas-schema-out-schema.json
- **JSONSchema** — https://artifacts.apis.io/farofinance-app/json-schema/farofinance-app-verify-before-pay-in-schema.json
- **JSONSchema** — https://artifacts.apis.io/farofinance-app/json-schema/farofinance-app-payment-intent-in-schema.json

## Other Faro APIs (1)

- [Faro API](https://apis.io/apis/farofinance-app/faro-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/farofinance-app/faro-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/farofinance-app/.
