Yojana Developer Platform v1

Build with Global Benefits Intelligence

Integrate real-time government scheme directories, program rules, document checklists, and the unified cross-country eligibility engine into your civic apps, portals, or case management software.

Get API Key Embeddable Widget Demo

Authentication

All requests to the Yojana v1 API require an HTTP Bearer Token passed via the Authorization header. Keys are scoped per organization and environment.

Authorization: Bearer yk_live_xxxxxxxxxxxxxxxxxxxxHeader

Production Keys

Prefixed with yk_live_. Rate limit: 100 requests/minute.

Sandbox Keys

Prefixed with yk_test_. Safe for testing and staging.

Interactive Code Example

# 1. List programs with filters
curl -X GET "https://yojanaeligibility.org/api/v1/programs?country=US&category=food&limit=10" \
  -H "Authorization: Bearer yk_live_YOUR_API_KEY"

# 2. Check user eligibility programmatically
curl -X POST "https://yojanaeligibility.org/api/v1/eligibility/check" \
  -H "Authorization: Bearer yk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "countryCode": "US",
    "stateCode": "CA",
    "age": 28,
    "annualIncome": 22000,
    "householdSize": 3,
    "employmentStatus": "unemployed"
  }'

API Endpoints Catalog

GET/api/v1/programs

Scope: PROGRAM_READ

Queries and filters welfare schemes and government benefits. Supports jurisdiction filtering, keywords, categories, and pagination.

// Parameters

?country=US|IN (Optional) - Filter by country ISO code

?category=health|food|housing (Optional) - Filter by category slug

?search=keywords (Optional) - Free-text title or keyword query

?limit=20&page=1 (Optional) - Pagination controls

GET/api/v1/programs/:id

Scope: PROGRAM_READ

Retrieves exhaustive details for a specific program, including structured eligibility criteria rules, document requirements, and verified official government portals.

POST/api/v1/eligibility/check

Scope: ELIGIBILITY_CHECK

Evaluates a user profile against hundreds of programmatic rules using our unified global evaluation engine.

// Request Body (JSON)

{ countryCode: 'US', stateCode: 'CA', age: 28, annualIncome: 24000, householdSize: 2 }

Webhooks & Event Subscriptions

Configure HTTPS webhook endpoints to receive near-instant notifications when programs undergo policy modifications or when new assistance referrals are assigned to your organization.

program.updated

Rules or benefit amounts revised

referral.created

User requested navigation help

Need an API Key?

Organizations registered in the Yojana Partner Ecosystem receive instant access to Sandbox API keys and Webhook management.

No Code? Use Embed Widgets

Add an interactive benefits discovery screener or search bar directly to your website with a single line of HTML iframe code.

Launch Widget Configurator

Security Standards

HTTPS TLS 1.3 encryption on all endpoints.
Hashed key storage (SHA-256); secret never stored in plaintext.
Full tenant isolation by Organization ID.
Zero user telemetry sold or shared without consent.