Last update:
Invitation API integration
Aug 21, 2026
API is exposed through Aikyam Service Gateway and portal team needs to make a request to HSID team to enable access to the API. Below are the Prerequisites to integrate the API.
- Portal or application should be already onboarded on HSID.
- Prepare for EiMP Golden Record for the PR or CG by following ESRO 8F.1.03 Policy, before calling Invitation API. PR or CG might or might not have a EiMP Golden Record, as they might not be UHC insurance members. This Golden Record will have MemberType=”PR” attribute with it. EiMP has a solution for the portal owners to prepare non-member EiMP Golden Record on the fly, however, the effort to use this solution varies, and HSID team recommends that the portal owners discuss with EiMP team first before applying this solution.
- Store the relationship between PR / CG and Representee / Care Receiver, and its effective period. HSID only helps PR / CG’s HSID account registration. HSID neither is aware of, nor uses this delegation relationship.
- Extract the registration link from the API response and communicate to the PR or CG. It can be through email, SMS or any other means. When the PR or CG clicks on the registration link, it triggers the registration process on HSID platform for the PR or CG.
- Authorize this relationship upon PR / CG’s registration and every login. Once HSID account registration is completed, PRs / CGs are authenticated same as other HSID “matched” (EiMP GR associated) account. Whether PRs / CGs have authorization to be PR / CG should be decided by the target portal (by using stored delegation relationship above), after login OIDC / HSID authentication completes, and lands on the target portal.
- If PR or CG happens to be an authorized member of your application, your application can utilize the regular registration / Fast Track registration invitation, instead of PR invitation.
- While this invitation / registration switch is desirable, in order to implement this switch, the portal needs to accurately identify if this prospect PR or CG is an authorized member or not, before HSID account registration; otherwise PR or CG might neither have / know their HSID registration identifiers at the time of the registration, nor you application can call Fast Track registration API with the identifier.
API Endpoints
See “Fast Track Registration -Invitation API Integration – API Endpoints” section.
Get access token
See “Fast Track Registration -Invitation API Integration – Get access token” section.
Sample request
See “Fast Track Registration -Invitation API Integration – Sample Request (Matched FTR)” section. The differences are:
- All fields are mandatory except expiration_date / expiration_time (email_address is required). Different from Fast Track Registration, the caller provides eid in addition to other attributes. “identifier” field is not required.
- context.properties:
- eid: EiMP enterprise ID (EiMP enterprise ID) of Personal Rep / Caregiver.
- flowType: “PR”
- accountlookup: “false” (For this PR/CG flow, invitation link should be generated even HSID account exists with the provided identity attributes. The link will guide the account holder to “you may have an account” HSID page if the account exists.)
- expiration_date / expiration_time: By default, expiration of the link is set to 72 hours for flowType = “PR”, however it can be overridden by passing these attributes. Regarding formatting and rules, please see “Fast Track Registration - Invitation API Integration Sample Request (Matched FTR)” section.
- context.properties:
Sample response
See “Fast Track Registration - Invitation API Integration– Sample Response (Matched FTR)” section.
Sample error response
See “Fast Track Registration -Invitation API Integration– Sample Error Response (Matched FTR)” section.
Share additional feedback to help us improve.
0/255
|
Powered by Aikyam @2025 All rights reserved
+1 866 451 2735
+1 866 451 2735
+1 855 819 5909