Overview

API Reference

Four partner-facing services

View as Markdown

Gooclaim exposes four services to TPA and Insurer partners. All other Gooclaim services are internal and not callable from outside.

The four services

Auth Service

Issues JWTs for all subsequent API calls. RS256-signed, short-lived.

Workflow Engine

Inspect, control, and observe workflow instances (Claim Status, Pending Documents, Query Reason).

Audit Ledger

Tenant-scoped read access to the immutable audit ledger. For your own IRDAI compliance reporting.

Outbound Webhooks

Event schemas for the webhooks Gooclaim pushes to you.

Base URLs

EnvironmentBase URL
Productionhttps://api.gooclaim.com
Developmenthttps://api.dev.gooclaim.com

All business endpoints are mounted under /v1/*. Infrastructure endpoints (/health, /ready, /metrics) stay at the root and are not part of the partner API contract.

Conventions

  • Auth — Authorization: Bearer <JWT> on every request except POST /v1/auth/token.
  • Tenant scoping — your JWT carries tenant_id. Every response is filtered to your tenant. You cannot read another tenant’s data.
  • PHI safety — claim IDs, phone numbers, and names are hashed (sha256:...) in any returned payload. If you need to correlate back to a plaintext identifier, do that in your own system.
  • Errors — RFC 7807 problem-detail JSON, with a stable error_code string.
  • Idempotency — mutating endpoints accept Idempotency-Key headers.

Rate limits

Endpoint familyLimit
POST /v1/auth/token60 / min / client_id
GET /v1/workflows/*600 / min / tenant_id
GET /v1/audit/events300 / min / tenant_id

Exceeding the limit returns 429 Too Many Requests with a Retry-After header.

SDKs

Generated SDKs are planned for v1.0:

  • Python (pip install gooclaim)
  • Node.js (npm install @gooclaim/sdk)
  • Go (go get github.com/gooclaim-claimos/gooclaim-go)

Hand-written SDKs are not maintained — always use the generated ones once released.

Need help?