API references
Every endpoint below is generated from the specification that declares it. Each one has its own page with the headers, the body and a request you can send.
This page lists every module, including any that the role you have chosen does not use. The sidebar shows only yours.
In M2 and M3 a call is acknowledged now and answered later. The answer arrives as a callback, a POST from ABDM to the URL you registered, declared in the specification as a webhook. Each callback is shown on the call it belongs to, and has a page of its own under that module.
Gateway session
4 endpoints across 2 use cases: Bridge, Session. Each endpoint has its own page in the sidebar.
M1 Identity
122 endpoints across 10 use cases: Create ABHA, Child ABHA, Login, Profile, ABHA Card & Profile, Find ABHA, Forgot ABHA, Benefit, Access Tokens & Encryption, ABHA Address Login. Each endpoint has its own page in the sidebar.
M2 Health Information Provider
20 endpoints across 5 use cases: Link token, HIP initiated linking, User initiated linking, Consent and data flow, Callbacks. Each endpoint has its own page in the sidebar.
M3 Health Information User
12 endpoints across 2 use cases: Consent and data flow, Callbacks. Each endpoint has its own page in the sidebar.
M4 Registry Integration
100 endpoints across 4 use cases: HPID, HFR, HRP bridge services, HPR. Each endpoint has its own page in the sidebar.
P1 Registration and login
42 endpoints across 4 use cases: PHR certificate and session token, Create ABHA number, Aadhaar OTP, Create ABHA address, PHR login. Each endpoint has its own page in the sidebar.
P2 Consents Management
46 endpoints across 5 use cases: PHR profile, Link ABHA number, Quick OPD Registration, User initiated linking, Consent manager. Each endpoint has its own page in the sidebar.
P3 Subscription
14 endpoints across 2 use cases: Subscription request and notifications, HIU side, Subscription approval and management, PHR side. Each endpoint has its own page in the sidebar.
P4 Locker
5 endpoints across 1 use case: Locker. Each endpoint has its own page in the sidebar.
Scan and Register
2 endpoints across 1 use case: Scan and register. Each endpoint has its own page in the sidebar.
Patient scan and record share
11 endpoints across 1 use case: Record share. Each endpoint has its own page in the sidebar.
Scan and Pay
18 endpoints across 2 use cases: Scan and pay, Scan and pay details and version update. Each endpoint has its own page in the sidebar.