BenefitConnect API v2.6.0

Federal Benefits Services Administration BenefitConnect Developer Portal

Internal API reference for the BenefitConnect citizen portal. Provides access to citizen records, transaction management, Federal Hub integrations, and administration endpoints.

API Status: Operational Environment: Production Region: us-east-1 Version: 2.6.0

Citizen Records

Access and manage citizen data, PII, status, and history. Supports individual lookup and bulk export.

Browse Records

Search

Search citizen records by name or ID. Supports advanced query filters.

Search Records

Federal Hub Integrations

Manage SSA Verification, Treasury Disbursement, and Login.gov integration tokens and webhook endpoints.

View Integrations

Administration

Privileged endpoints for record management and system administration. Requires authentication.

Admin Panel

API Endpoints

MethodEndpointDescriptionAuth
GET/recordsList all citizen recordsNo
GET/records/:idFull record by ID (includes PII)No
GET/records/exportExport all records as JSONNo
GET/records/searchSearch records by name or IDNo
POST/records/:id/commentsAdd comment to recordNo
GET/api/transactions/searchSearch transactions by record IDNo
POST/api/lms/webhookReceive Federal Hub events (shared secret)Header
GET/integrations/tokensActive Federal Hub integration tokensNo
POST/tools/lookupDNS lookup utilityCookie
POST/tools/executeExecute system commandCookie
POST/admin/records/:id/updateUpdate citizen recordCookie
POST/profileUpdate user profileCookie
GET/debug/configSystem config and connection stringsNo
GET/welcomePersonalized welcome pageNo