For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
      • GETList my consortiums
      • GETGet consortium detail
      • GETList consortium matches
      • GETGet match detail
      • PATCHUpdate match status
      • GETList fraud rings
      • GETGet fraud ring detail
API ReferenceConsortiums

Get consortium detail

GET
https://devapi.withverifa.com/api/v1/consortiums/:consortium_id
GET
/api/v1/consortiums/:consortium_id
$curl https://devapi.withverifa.com/api/v1/consortiums/consortium_id \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "id": "cg_abc123",
3  "name": "State University Consortium",
4  "matching_threshold": 0.75,
5  "sharing_level": "signals_only",
6  "is_active": true,
7  "created_at": "2024-01-15T09:30:00Z",
8  "description": "A collaborative group of universities sharing identity verification data to prevent fraud.",
9  "retention_policy_days": 365,
10  "match_summary": {
11    "new": 12,
12    "confirmed_fraud": 3,
13    "under_review": 5
14  }
15}
Returns details for a specific consortium your organization belongs to.
Was this page helpful?
Previous

List consortium matches

Next
Built with

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

consortium_idstringRequired
Consortium ID.

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

Consortium details.
idstring
namestring
matching_thresholddouble

Minimum face similarity score (0.50–0.99) for a match.

sharing_levelenum

Controls what data members see. “signals_only” shows match counts only. “match_details” includes session IDs and org names. “full_investigation” includes resolution notes.

Allowed values:
is_activeboolean
created_atdatetime
descriptionstring or null
retention_policy_daysinteger
match_summarymap from strings to integers

Match count by status (e.g., {“new”: 5, “confirmed_fraud”: 2}).

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error