> ## Documentation Index
> Fetch the complete documentation index at: https://developer.eka.care/llms.txt
> Use this file to discover all available pages before exploring further.

# Profile Share V1

> Fetch the token from a hospital. <Note> Get the hip_id and counter_id by reading the QR code of the Hospital/Clinic.</Note> <Note>Use the device location for the location data</Note>



## OpenAPI

````yaml api-reference/user-app/abdm-connect/registration.yml POST /abdm/v1/profile/share
openapi: 3.1.0
info:
  description: >-
    ABHA identity, care context linking, consent, HPR/HFR, UHI and
    scan-and-share APIs, with the webhook events Eka sends.
  title: ABDM Connect
  version: 1.0.0
servers:
  - description: Production
    url: https://api.eka.care
  - description: Stage/Sandbox
    url: https://api.dev.eka.care
security: []
paths:
  /abdm/v1/profile/share:
    post:
      tags:
        - Scan and Share
      summary: Profile Share V1
      description: >-
        Fetch the token from a hospital. <Note> Get the hip_id and counter_id by
        reading the QR code of the Hospital/Clinic.</Note> <Note>Use the device
        location for the location data</Note>
      operationId: profileShareV1
      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
        - description: OID is used to Identify the user.
          in: query
          name: oid
          schema:
            description: OID is used to Identify the user.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanandshareRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HipQRScanShareProfileResponseV2'
          description: OK
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: ''
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
          description: ''
      security:
        - authApiKey: []
components:
  schemas:
    ScanandshareRequest:
      properties:
        counter_id:
          description: Counter ID from QR Code
          type: string
        hip_id:
          description: HIP ID from QR Code
          type: string
        location:
          $ref: '#/components/schemas/HipLocation'
          description: Location of the user
        patient:
          $ref: '#/components/schemas/ScanandsharePatient'
          description: Patient details
      required:
        - counter_id
        - hip_id
      type: object
    HipQRScanShareProfileResponseV2:
      properties:
        address:
          description: Address associated with the HIP.
          type: string
        created_at:
          format: date-time
          type: string
        footer:
          type: string
        hip_id:
          description: Health Information Provider (HIP) identifier
          type: string
        hip_name:
          description: Name of the Health Information Provider (HIP)
          type: string
        request_id:
          description: Unique identifier for the request
          type: string
        show_token_screen:
          type: boolean
        token_expiry:
          format: date-time
          type: string
        token_number:
          type: string
      type: object
    GenericError:
      properties:
        code:
          type: integer
        error:
          type: string
        source_error:
          $ref: '#/components/schemas/SourceErr'
      type: object
    HipLocation:
      properties:
        latitude:
          type:
            - 'null'
            - string
        longitude:
          type:
            - 'null'
            - string
      type: object
    ScanandsharePatient:
      properties:
        abha_address:
          description: ABHA address of the patient
          type: string
        address:
          $ref: '#/components/schemas/ScanandshareAddress'
          description: Address of the patient
        day_of_birth:
          description: Day of birth of the patient
          type: string
        gender:
          description: Gender of the patient
          type: string
        mobile:
          description: Phone number of the patient
          type: string
        month_of_birth:
          description: Month of birth of the patient
          type: string
        name:
          description: Name of the patient
          type: string
        year_of_birth:
          description: Year of birth of the patient
          type: string
      required:
        - abha_address
        - name
        - gender
        - day_of_birth
        - month_of_birth
        - year_of_birth
        - mobile
      type: object
    SourceErr:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    ScanandshareAddress:
      properties:
        district:
          description: District of the address
          type: string
        line:
          description: Address line
          type: string
        pin_code:
          description: Pin code of the address
          type: string
        state:
          description: State of the address
          type: string
      required:
        - pin_code
      type: object
  securitySchemes:
    authApiKey:
      description: The API requires a Bearer token (JWT) for authentication.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.