abha search

api-reference/user-app/abdm-connect/profile/search/search.mdx

@@ -0,0 +1,4 @@
+---
+openapi: get /abdm/v1/profile/search
+title: Search ABHA
+---

api-reference/user-app/abdm-connect/registration.yml

@@ -3477,6 +3477,50 @@ paths:
           description: OK
       security:
       - authApiKey: []
+  /abdm/v1/profile/search:
+    get:
+      description: Search KYCed ABHA profiles using mobile number
+      parameters:
+      - description: Eka User ID (OID)
+        in: header
+        name: X-Pt-Id
+        schema:
+          type: string
+      - description: Partner User ID
+        in: header
+        name: X-Partner-Pt-Id
+        schema:
+          type: string
+      - description: Partner HIP ID
+        in: header
+        name: X-Hip-Id
+        schema:
+          type: string
+      - in: query
+        name: mobile
+        schema:
+          type: string
+      responses:
+        4XX:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenericError'
+          description: ""
+        5XX:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenericError'
+          description: ""
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProfileDiscoverAbhaResponse'
+          description: OK
+      security:
+      - authApiKey: []
   /abdm/v1/profile/share:
     post:
       description: Fetch the token from a hospital. <Note> Get the hip_id and counter_id
@@ -4715,6 +4759,25 @@ components:
           format: date-time
           type: string
       type: object
+    DiscoverAbha:
+      properties:
+        ABHANumber:
+          examples:
+          - xx-xxxx-xxxx-1525
+          type: string
+        gender:
+          examples:
+          - M
+          type: string
+        index:
+          examples:
+          - 1
+          type: integer
+        name:
+          examples:
+          - John Doe
+          type: string
+      type: object
     DiscoverCareContext:
       properties:
         display:
@@ -6121,6 +6184,17 @@ components:
           - Jharkhand
           type: string
       type: object
+    ProfileDiscoverAbhaResponse:
+      properties:
+        abha:
+          items:
+            $ref: '#/components/schemas/DiscoverAbha'
+          type:
+          - array
+          - "null"
+        txnId:
+          type: string
+      type: object
     ProfileResponse:
       properties:
         abha_address:

docs.json

@@ -560,6 +560,7 @@
                                         "icon": "user",
                                         "pages": [
                                             "api-reference/user-app/abdm-connect/profile/getting-started",
+                                            "api-reference/user-app/abdm-connect/profile/search/search",
                                             "api-reference/user-app/abdm-connect/profile/cards/qr-code",
                                             "api-reference/user-app/abdm-connect/profile/cards/abha-card",
                                             "api-reference/user-app/abdm-connect/profile/details/profile-details",