Sign in

v1

latestOpenAPI 3.0.02026-07-14327580.4 KB
Gateway

Initialize authentication from HIP

This API is called by HIPs to initiate authentication of users. A transactionId is retuned by the corresponding callback API for confirmation of user auth.

  1. NOTE, only KYC purpose is applicable for HIU. Hence HIU should only sent KYC in query.authMode in the request
post/v0.5/users/auth/init

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server, which will be sent by gateway to authenticate itself with API bridge.

X-CM-IDstring required

Suffix of the consent manager to which the request was intended.

Request body

requestIdstring uuid required

a nonce, unique for each HTTP request

timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

Example request

{
  "query": {
    "id": "hinapatel@ndhm"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request accepted