Skip to main content
GET
cURL

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

id
string
required

Consent/Subscription ID

type
enum<string>

Request type

Available options:
consent,
subscription
status
enum<string>

Status of the request

Available options:
requested,
granted,
expired,
denied,
revoked
oid
string

OID is used to Identify the user.

Response

OK

access_mode
enum<string>
Available options:
view
created_at
string<date-time>
duration
object
erase_at
string<date-time>
hi_types
object[] | null

List of HI Types

hiu
object

HIU details

id
string
providers
object[] | null

List of Providers/Failities details

purpose
object

Purpose of the request

requester
object

Requester details

status
enum<string>
Available options:
requested,
granted,
expired,
denied,
revoked
updated_at
string<date-time>