Skip to main content
POST
Profile Share V1

Authorizations

Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id
string

Eka User ID (OID)

X-Partner-Pt-Id
string

Partner User ID

X-Hip-Id
string

Partner HIP ID

Query Parameters

oid
string

OID is used to Identify the user.

Body

application/json
counter_id
string
required

Counter ID from QR Code

hip_id
string
required

HIP ID from QR Code

location
object

Location of the user

patient
object

Patient details

Response

OK

address
string

Address associated with the HIP.

created_at
string<date-time>
hip_id
string

Health Information Provider (HIP) identifier

hip_name
string

Name of the Health Information Provider (HIP)

request_id
string

Unique identifier for the request

show_token_screen
boolean
token_expiry
string<date-time>
token_number
string