Aikyam impersonation API call

Last update:

Aug 21, 2026

The access token retrieved in the previous section is used for Authorization Bearer header of this API call.

All data in JSON payload are required field.
- firstName
- lastName
- dob: date of birth, MM/dd/yyyy format.
- id: one of search_keys identifier.
- targetPortal: The target portal’s Aikyam Application ID.
- adminCntx: Portal-defined string that represents administrator privilege context. This value is passed in ID token eventually, and Portal can change the experience based on adminCntx (e.g. if adminCntx is not present, provide the regular user experience, if present, provide limited user experience - impersonated view, etc).

Sample response

Was this helpful?

We are sorry the content didn't meet your needs.

Share additional feedback to help us improve.

0/255 | Character limit exceeded.

Thank you so much for sharing your feedback!

On this page

Powered by Aikyam @2025 All rights reserved