MANSOQ Knowledge
← Technical API reference

Frontend module · STATIC DECLARATIONS

Mansoq Api client API reference · mansoq-abdm

35 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Client contract scope

These 35 declarations come from repositories/platform/mansoq-abdm/frontend/src/lib/mansoqApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
routes.hostFacility GET /api/v1/facility/{facilityId}/ literal
routes.gatewayStatus GET /api/abdm/gateway/status literal
routes.bridge GET /api/abdm/bridge literal
routes.bridgeRegisterUrl POST /api/abdm/bridge/register-url literal
routes.adminOverview GET /api/abdm/admin/overview literal
routes.facilityAbdm GET /api/abdm/facilities/{facilityId}/abdm literal
routes.updateFacilityAbdm PUT /api/abdm/facilities/{facilityId}/abdm literal
routes.registerHrpService POST /api/abdm/facilities/{facilityId}/abdm/hrp-services literal
routes.profileShares GET /api/abdm/facilities/{facilityId}/abdm/profile-shares literal
routes.profileShare GET /api/abdm/facilities/{facilityId}/abdm/profile-shares/{shareId} literal
routes.dismissProfileShare POST /api/abdm/facilities/{facilityId}/abdm/profile-shares/{shareId}/dismiss literal
routes.callbacks GET /api/abdm/callbacks literal
routes.callback GET /api/abdm/callbacks/{callbackId} literal
routes.encounterCareContext GET /api/abdm/encounters/{encounterId}/care-context literal
routes.encounterCareContextLink POST /api/abdm/encounters/{encounterId}/care-context/link literal
routes.shareItemAction POST /api/abdm/encounters/{encounterId}/share-items/{itemId}/{action} literal
routes.patientSmsLink POST /api/abdm/patients/{patientId}/abha/sms-link literal
routes.patientConsents GET /api/abdm/patients/{patientId}/abha/consents literal
routes.consentRequests GET /api/abdm/patients/{patientId}/abha/consent-requests literal
routes.createConsentRequest POST /api/abdm/patients/{patientId}/abha/consent-requests literal
routes.consentRequestAction POST /api/abdm/patients/{patientId}/abha/consent-requests/{requestId}/{action} literal
routes.fetchedRecord GET /api/abdm/patients/{patientId}/abha/records/{recordId} literal
routes.providers GET /api/abdm/providers literal
routes.requestAadhaarOtp POST /api/abdm/abha/enrol/aadhaar/request-otp literal
routes.enrolByAadhaar POST /api/abdm/abha/enrol/aadhaar/verify literal
routes.requestMobileOtp POST /api/abdm/abha/enrol/mobile/request-otp literal
routes.verifyMobileOtp POST /api/abdm/abha/enrol/mobile/verify literal
routes.addressSuggestions POST /api/abdm/abha/enrol/address/suggestions literal
routes.claimAbhaAddress POST /api/abdm/abha/enrol/address/claim literal
routes.loginRequestOtp POST /api/abdm/abha/login/request-otp literal
routes.loginVerifyOtp POST /api/abdm/abha/login/verify literal
routes.loginSelectAccount POST /api/abdm/abha/login/select-account literal
routes.transaction GET /api/abdm/abha/transactions/{txnId} literal
routes.patientAbha GET /api/abdm/patients/{patientId}/abha literal
routes.patientAbhaLink POST /api/abdm/patients/{patientId}/abha/link literal

routes.hostFacility

Host route, not a plug route. The setup page gets only facilityId from the URL, so it reads the facility name from MANSOQ to show a page header. Source: mansoq-web/src/types/facility/facilityApi.ts:34-38.

GET /api/v1/facility/{facilityId}/. HTTP option object; client/server ownership review pending; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.gatewayStatus

GET /api/abdm/gateway/status. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.bridge

GET /api/abdm/bridge. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.bridgeRegisterUrl

POST /api/abdm/bridge/register-url. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.adminOverview

GET /api/abdm/admin/overview. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.facilityAbdm

GET /api/abdm/facilities/{facilityId}/abdm. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.updateFacilityAbdm

PUT /api/abdm/facilities/{facilityId}/abdm. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.registerHrpService

POST /api/abdm/facilities/{facilityId}/abdm/hrp-services. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.profileShares

GET /api/abdm/facilities/{facilityId}/abdm/profile-shares. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.profileShare

GET /api/abdm/facilities/{facilityId}/abdm/profile-shares/{shareId}. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: facilityId, shareId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.dismissProfileShare

POST /api/abdm/facilities/{facilityId}/abdm/profile-shares/{shareId}/dismiss. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: facilityId, shareId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.callbacks

GET /api/abdm/callbacks. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.callback

GET /api/abdm/callbacks/{callbackId}. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: callbackId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.encounterCareContext

GET /api/abdm/encounters/{encounterId}/care-context. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: encounterId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.encounterCareContextLink

POST /api/abdm/encounters/{encounterId}/care-context/link. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: encounterId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.shareItemAction

POST /api/abdm/encounters/{encounterId}/share-items/{itemId}/{action}. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: encounterId, itemId, action. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.patientSmsLink

POST /api/abdm/patients/{patientId}/abha/sms-link. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.patientConsents

GET /api/abdm/patients/{patientId}/abha/consents. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.consentRequests

GET /api/abdm/patients/{patientId}/abha/consent-requests. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.createConsentRequest

POST /api/abdm/patients/{patientId}/abha/consent-requests. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.consentRequestAction

POST /api/abdm/patients/{patientId}/abha/consent-requests/{requestId}/{action}. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId, requestId, action. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.fetchedRecord

GET /api/abdm/patients/{patientId}/abha/records/{recordId}. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId, recordId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.providers

GET /api/abdm/providers. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.requestAadhaarOtp

POST /api/abdm/abha/enrol/aadhaar/request-otp. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.enrolByAadhaar

POST /api/abdm/abha/enrol/aadhaar/verify. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.requestMobileOtp

POST /api/abdm/abha/enrol/mobile/request-otp. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.verifyMobileOtp

POST /api/abdm/abha/enrol/mobile/verify. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.addressSuggestions

POST /api/abdm/abha/enrol/address/suggestions. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.claimAbhaAddress

POST /api/abdm/abha/enrol/address/claim. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.loginRequestOtp

POST /api/abdm/abha/login/request-otp. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.loginVerifyOtp

POST /api/abdm/abha/login/verify. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.loginSelectAccount

POST /api/abdm/abha/login/select-account. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.transaction

GET /api/abdm/abha/transactions/{txnId}. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: txnId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.patientAbha

GET /api/abdm/patients/{patientId}/abha. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

routes.patientAbhaLink

POST /api/abdm/patients/{patientId}/abha/link. HTTP option object; client/server ownership review pending; literal. no exact statically resolved backend match in scanned contracts.

Path parameters: patientId. Transport strings are declared here; semantic identifier types require the server contract.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.