API v2 · REST + webhooks

Build on the Clinic Record

Read and write couples, cycles, embryos and invoices over a plain JSON API. Subscribe to cycle events. Same permissions model as the app, down to the role.

/
Quick start
GET /v2/cycles/cyc_8f2a 
curl https://api.conceivexsoftware.in/v2/cycles/cyc_8f2a \
  -H "Authorization: Bearer $CONCEIVEX_KEY"
200 OK84 ms · application/json
{
  "id": "cyc_8f2a",
  "couple_id": "cpl_3k9d",
  "type": "icsi",
  "protocol": "antagonist",
  "status": "stimulating",
  "day": 7,
  "monitoring": [
    { "day": 5, "e2": 980,  "follicles": { "≥14mm": 4 } },
    { "day": 7, "e2": 1860, "follicles": { "≥14mm": 9, "≥18mm": 2 } }
  ],
  "consents": { "8": "signed", "10": "signed", "11": "pending" },
  "centre_id": "ctr_pune",
  "updated_at": "2026-10-03T08:14:22+05:30"
}

Quick start

First Request in Five Minutes

1

Create a key

Settings → Integrations → New API key. Pick the role it should act as. Keys are shown once.

ck_live_4f9…   role: embryologist   centre: ctr_pune
2

Make a request

Bearer token in the Authorization header. All responses are JSON; times are ISO 8601 with offset.

curl https://api.conceivexsoftware.in/v2/cycles?status=stimulating \
  -H "Authorization: Bearer ck_live_4f9…"
3

Handle pagination

Lists return next_cursor. Pass it back as cursor until it is null.

GET /v2/cycles?cursor=eyJpZCI6ImN5Y184ZjJhIn0
4

Subscribe to events

Register a webhook URL and verify the signature with your signing secret.

POST /v2/webhooks
{ "url": "https://lis.yourlab.in/hooks/conceivex",
  "events": ["embryo.witnessed", "cycle.triggered"] }

Authentication & limits

Keys Scoped Like Staff Logins

Every key belongs to a role you already have in the app. A key with the embryologist role sees what an embryologist sees, and nothing a billing clerk does.

Scheme

Bearer key

One key per integration, bound to a role and optionally a centre.

Rate limit

600 / min

Per key. Burst to 100 per second. 429 with Retry-After when exceeded.

Data residency

India only

Mumbai and Hyderabad regions. No cross-border replication.

Request headers

Authorization: Bearer ck_live_4f9…
Content-Type: application/json
Idempotency-Key: 7f3c-…   # optional on POST
X-Centre: ctr_pune         # optional, for chain keys

Rate-limit response

HTTP/1.1 429 Too Many Requests
Retry-After: 12
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 0

{ "error": "rate_limited", "retry_after": 12 }

Reference

Resources and Endpoints

The couple is the root record. Partners, identifiers (ABHA, MRN), consents and counselling sit under it.

GET/v2/couplesRole: Front desk

Paginated list, newest first. Filter by registration date, centre or assigned doctor.

Parameters

centre_idstringRestrict to one centre
registered_afterdateISO 8601
limitint1–100, default 25

Example

curl https://api.conceivexsoftware.in/v2/couples?limit=2 \
  -H "Authorization: Bearer $KEY"

{ "data": [ { "id": "cpl_3k9d", "mrn": "AFC-2026-0412",
    "partners": [ { "role": "female", "abha": "91-xxxx-xxxx-1182" },
                  { "role": "male" } ],
    "centre_id": "ctr_pune" } ],
  "next_cursor": "eyJpZCI6ImNwbF8zazlkIn0" }

Webhooks

Events, As They Happen

Register an HTTPS endpoint and we POST a signed JSON body within two seconds of the event. Retries for 24 hours with backoff; every delivery visible in the app.

PayloadX-ConceiveX-Signature: sha256=…

{ "id": "evt_01HZX", "type": "cycle.started",
  "created_at": "2026-10-03T08:14:22+05:30",
  "data": { "cycle_id": "cyc_8f2a", "couple_id": "cpl_3k9d",
            "type": "icsi", "protocol": "antagonist" } }

API changelog

Versioned, Never Silently

2026-09-28AddedGET /v2/reports/outcomes gains age_band and per_intended_retrieval.
2026-09-10Addedembryo.witnessed webhook now includes the failing label on result: fail.
2026-08-19ChangedInvoice totals are integers in paise; the decimal rupees field is deprecated in v1.
2026-07-30FixedCursor pagination on /v2/appointments no longer skips rows across midnight.

Breaking changes ship as a new version with 12 months of overlap. v1 is supported until 30 Jun 2027. Release notes for the app are on What’s New.

Errors

One Envelope, Named Codes

Every non-2xx response carries the same JSON body. The code is stable; the message is for humans and may change.

Error envelope

HTTP/1.1 409 Conflict

{
  "error": "consent_missing",
  "message": "Form 10 must be signed before an ICSI cycle starts.",
  "forms": ["10"],
  "request_id": "req_01J7Q…",
  "docs": "https://conceivexsoftware.in/api#errors"
}

Log request_id with every failure; support can trace a request from it for 90 days.

400validation_failedA field is missing or malformed. The errors array names each field.
401unauthenticatedKey missing, revoked or for the wrong environment (sandbox vs live).
403role_forbiddenThe key’s role cannot see or change this resource. Same rule as the app.
404not_foundNo such ID, or it belongs to a centre the key is not scoped to.
409consent_missingThe clinical step needs a prescribed form on file first. forms lists which.
422witness_mismatchScanned label does not match the couple. Logged to the ART register.
429rate_limitedOver 600 requests a minute. Honour Retry-After.

Built on the API

Already Connected to Your Stack

Integrations clinics switch on from Settings, each built by the partner against this documentation.

Scan centresPOST /monitoring

Radiance Imaging Network

Posts follicle counts and E2 straight into the monitoring visit.

LabPATCH /embryos

Vitrolife Time-lapse

Embryo images and annotations attached to the embryo record.

Labembryo.witnessed

CryoTrack LIS

Tank maps and straw moves synced both ways with witness events.

Accountinginvoice.paid

Tally Prime

Issued invoices and payments posted as vouchers nightly.

AccountingGET /invoices

Zoho Books

GST-ready invoice sync with per-line tax treatment preserved.

Patient commsappointment.*

WhatsApp Business

Appointment and medication reminders from the couple record.

IdentityPATCH /couples

ABDM Gateway

ABHA creation and linking at registration, verified IDs on the record.

InsurancePOST /payments

Medi Assist TPA

Pre-authorisation from the package screen; status back on the invoice.

Building something clinics would want? Partner listings get sandbox access, a technical review and a place in Settings.

Apply to the partner programme

Pricing

API Access, On Every Plan

Read access to your own data is included on every plan. Higher tiers add write scopes, webhooks, higher rate limits and sandbox seats for your integration partners.

Save ₹200/mo annually

Starter

5–25 licences

Single-centre clinics

₹1,700 /month

Billed monthly

Get Started
  • Read-only API for all resources
  • 1 API key, 300 requests/min
  • Sandbox clinic with seeded data
  • Invoice PDF and report exports
  • OpenAPI spec and Postman collection
  • Community forum support
  • 24 hrs/year support
  • 3 hrs integration onboarding
MOST POPULAR

Growth

25–100 licences

Clinics with a lab or scan-centre integration

₹1,500 /month

Billed monthly

Get Started

Everything in Starter, plus:

  • Write scopes: couples, appointments, monitoring
  • Webhooks, 6 event types
  • 5 API keys, 600 requests/min
  • Idempotency keys on POST
  • Named solutions engineer for go-live
  • Switch on any listed partner integration
  • 48 hrs/year support
  • 5 hrs onboarding incl. a webhook review

Advanced

100–200 licences

Clinics with several integrations

₹1,300 /month

Billed monthly

Get Started

Everything in Growth, plus:

  • Write scopes: embryos, witnessing, invoices
  • All webhook events incl. consent and witness
  • 20 API keys, 1,200 requests/min
  • Per-centre scoped keys
  • Bulk export endpoints, nightly
  • Early access to beta endpoints
  • Audit log API for every key
  • 48 hrs/year support

Enterprise

200+ licences

Chains and integration partners

Custom pricing

Tailored for your network

Get Started

Everything in Advanced, plus:

  • Unlimited keys and custom rate limits
  • Dedicated sandbox per partner team
  • Custom webhook event filters
  • Annual integration security review
  • Dedicated integration engineer
  • 12-month notice on any breaking change

Our prices are final and non-negotiable to ensure fairness for all our clients.

From the teams who built against v2

What Integrators Say About the API

Our LIS was posting witness events to the sandbox the same afternoon we read the docs. Production took a week, mostly our side.
Karthik RaoHead of Engineering, CryoTrack LISLab systems partner
Role-scoped keys meant I did not have to argue with our DPO. The scan-centre key sees monitoring visits and nothing else, and the audit log proves it.
Dr. Meera KulkarniDirector, Aarambh Fertility Centre, PuneLevel 2 clinic
Seven centres, one Tally instance. invoice.paid webhooks post the voucher nightly and finance stopped re-keying in March.
Rahul MenonGroup CEO, Nurture IVF NetworkSeven-centre chain

Security & Compliance

Power Your IVF Practice with ConceiveX
India’s Secure, Compliant IVF Platform

Patient records, embryology data and billing, protected by healthcare-grade security and national health standards.

NHA Approved

IVF clinic records recognised under India’s digital health standards.

ABDM Compliant

First IVF platform integrated with the ABDM health network.

ART Act Compliant

Built for India’s ART (Regulation) Act, 2021 for IVF clinics and banks.

FHIR Compliant

IVF cycle, lab and patient records interoperable on the FHIR standard.

ICMR Guidelines

Follows ICMR national guidelines for ART clinics and embryology labs.

Rated by developers and IT leads

Top-Rated for API and Integrations

Reviewers single out the documentation, the seeded sandbox and webhook reliability as the reasons integrations shipped on time.

SoftwareSuggest badge

5.0/5

SoftwareSuggest

Best API, Winter 2023

Slashdot badge

5.0/5

Slashdot

Reviews mention the docs

Capterra badge

4.6/5

Capterra

Rated for ease of integration

Software Advice badge

4.8/5

Software Advice

Rated for webhook reliability

SourceForge badge

5.0/5

SourceForge

5 stars for the sandbox

Itemised

Straight Answers on the API

How do I get API keys?2 min

Sandbox keys are issued from the developer console in about two minutes. Production keys are enabled once a solutions engineer has reviewed your integration, usually within two working days. Keys come from the developer console; a solutions engineer enables production.

Is the API included in the price?2 min

Yes. REST endpoints, webhooks and the sandbox come with every plan, ₹1,300 to ₹1,700 a login a month plus GST, with no separate API licence or per-call fee. Keys come from the developer console; a solutions engineer enables production.

Are there rate limits?2 min

Yes. 600 requests a minute per key in production, 120 in the sandbox. Limits and remaining quota are returned in response headers. Keys come from the developer console; a solutions engineer enables production.

Is the sandbox seeded with data?2 min

Yes. Sample couples, cycles, results, invoices and a mapped cryo tank, reset nightly, so you can test against realistic records without touching a clinic. Keys come from the developer console; a solutions engineer enables production.

Do partner integrators need their own account?2 min

Yes. Partners register once and are then authorised per clinic by that clinic's administrator, with scopes the clinic controls. Keys come from the developer console; a solutions engineer enables production.

Can a clinic revoke a key?2 min

Yes, from the console, immediately. Revocation is logged and any in-flight requests fail with a clear error. Keys come from the developer console; a solutions engineer enables production.

How is the API authenticated?OAuth 2.0

OAuth 2.0 client credentials for server-to-server, with short-lived access tokens and scoped permissions. API keys are for the sandbox only. See data security for the full controls.

Which scopes are available?OAuth 2.0

Read and write scopes per resource: patients, encounters, cycles, results, documents, appointments, invoices, payments, inventory and consents. See data security for the full controls.

Can a clinic limit what a partner can read?OAuth 2.0

Yes. The clinic administrator grants scopes per partner, and can exclude donor and surrogacy records by policy. See data security for the full controls.

How are webhooks verified?OAuth 2.0

Every webhook is signed with an HMAC-SHA256 header using your signing secret. Verify the signature and the timestamp before processing. See data security for the full controls.

Are tokens tied to a single clinic?OAuth 2.0

Yes. One token, one clinic. Chains receive a token per centre and a group token for consolidated read-only reporting. See data security for the full controls.

Is every API call logged?OAuth 2.0

Yes. Caller, scope, resource, time and IP are logged and visible to the clinic in the audit trail, as the DPDP Act expects. See data security for the full controls.

Which standards does the API use?FHIR R4

FHIR R4 for clinical resources, HL7 v2 for legacy hospital systems, and plain JSON REST for billing, inventory and scheduling. Hosted in India and ABDM-compliant; see data security.

Is the API ABDM compliant?FHIR R4

Yes. ABHA linking and FHIR health records follow the ABDM profiles, and ConceiveX is NHA-approved as a health information provider. Hosted in India and ABDM-compliant; see data security.

Where is API traffic processed?FHIR R4

In India, in the same encrypted environment as the clinical record. Nothing leaves the country. Hosted in India and ABDM-compliant; see data security.

Can patient identity be excluded from responses?FHIR R4

Yes. Request the de-identified representation and names, contact details and ABHA numbers are stripped, with donor identities always coded. Hosted in India and ABDM-compliant; see data security.

How is patient data protected in transit?FHIR R4

TLS 1.2 or higher only, with certificate pinning available for on-premise hospital gateways. Hosted in India and ABDM-compliant; see data security.

Who owns data exchanged over the API?FHIR R4

The clinic. ConceiveX is the processor and the Data Processing Agreement covers every integration the clinic authorises. Hosted in India and ABDM-compliant; see data security.

Which events can I subscribe to?24 h

Patient registered, appointment booked or changed, result posted, consent signed or withdrawn, cycle stage reached, invoice issued, payment received and straw moved. Test any event from the sandbox console before you go live.

How are webhooks delivered?24 h

HTTPS POST with a signed JSON body, delivered within a few seconds of the event, with the event ID for idempotency. Test any event from the sandbox console before you go live.

What happens if my endpoint is down?24 h

Deliveries retry with exponential backoff for 24 hours, and failed events can be replayed from the console. Test any event from the sandbox console before you go live.

Can I filter events?24 h

Yes. Subscribe per event type and, for chains, per centre. Test any event from the sandbox console before you go live.

Is there a webhook test tool?24 h

Yes. Fire any event from the sandbox console against your endpoint and inspect the request and your response. Test any event from the sandbox console before you go live.

Are webhook payloads versioned?24 h

Yes. Payloads carry a version field and we give 12 months' notice before retiring a version. Test any event from the sandbox console before you go live.

Which lab systems are already integrated?4

Thyrocare, Dr Lal PathLabs, Metropolis and SRL post results over FHIR. Any LIS that speaks HL7 v2 ORU can connect. See the analytics and billing modules the API feeds.

Can ultrasound machines send images directly?4

Yes. Follicle measurements and images arrive over DICOM from most machines into the scan entry. See the analytics and billing modules the API feeds.

Does the API connect to Tally and Zoho Books?4

Yes. Invoices, receipts, refunds and TPA settlements post daily, and the mapping to your ledgers is set in the console. See the analytics and billing modules the API feeds.

Which payment gateways and WhatsApp providers work?4

Razorpay and PayU for payments, and WhatsApp Business through our approved provider, with delivery status per message. See the analytics and billing modules the API feeds.

Can a hospital HIS consume the API?4

Yes. HL7 and FHIR interfaces for admissions, day-care beds, pharmacy and billing are documented with sample messages. See the analytics and billing modules the API feeds.

Is there a Power BI or Looker connector?4

Yes, on Advanced plans. The reporting warehouse is exposed with ready-made connectors and a documented schema. See the analytics and billing modules the API feeds.

Who do I call when an integration breaks?7 days

The seven-day line on +91 8860 460 800. Developer tickets reach a solutions engineer who has built integrations, not a script. Support runs seven days a week; see how support works.

Is there a status page?7 days

Yes. API uptime, latency and incident history are published, with email and webhook alerts for incidents. Support runs seven days a week; see how support works.

How do I report a bug in the docs or the API?7 days

From the feedback link on any reference page, or by email. Fixes to the docs ship within days. Support runs seven days a week; see how support works.

Are there SDKs?7 days

Yes. Node, Python and Java SDKs, plus a Postman collection and OpenAPI specification you can import into any tool. Support runs seven days a week; see how support works.

Is there a developer community?7 days

Yes. A moderated forum for integrators and a monthly office-hours call with the API team. Support runs seven days a week; see how support works.

Is integration support included in the price?7 days

Yes, on every plan, seven days a week, with no per-call charge. Support runs seven days a week; see how support works.

Sandbox keys in two minutes

Integrate Your LIS, Scan Centre or Accounting Stack

Start against the seeded sandbox today. When you are ready for production, a solutions engineer reviews your scopes and webhook handling with you.

Book Demo