Check the participant's access right

https://development.api.wealthcare.com/participant/services/participant/employee/accessattribute/{tpaId}/{employerId}/{participantId}

Retrieve the access rights of a specific participant based on their unique identifiers, allowing you to determine which features or functionalities they can access.

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.
employerId string Required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
participantId string Required

Unique identifier for the participant whose features are being queried.

Query parameters

accessAttributes enum<string>

A bit field representing one or more AccessAttributes enumeration values, used to check if the participant has access to specific features or functionalities. Combine values by adding them together to request multiple attributes simultaneously.

Possible values: None AllowParticipantClaimEntry AllowParticipantReceiptUpload AllowParticipantPayProvider AllowParticipantEmailUpdates AllowParticipantEmailAdmin AllowParticipantAccessDependentInfo AllowParticipantRequestNewCard AllowParticipantUpdateDemoInfo AllowParticipantUpdateDirectDepositInfo AllowParticipantViewDirectDepositInfo AllowParticipantClaimsCrossOver AllowParticipantCommunicationSelection AllowEmpeSelfCreation AllowParticipantUpdateAutoReimbSettings AllowParticipantAddDependent AllowParticipantLinkDependentAccount AllowParticipantCreateDependentCard AllowParticipantRequireDependentDOBSSN AllowParticipantCardReimbursement IsEligibleEnroll GetAcctClassification GetInnoPartners GetParticipantPortalAccessInfo EmployerNoDebitCard DirectDepositBankAccountValidation AllowParticipantOnlineRepayment AllowOfflineSAAuthenticationToken AllowSAFeatureOnOff AllowParticipantTransaction
decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

Response

AcctsWaitingAdditionalInformation array <string>

Returns Flex Account ID for the HSA account(s) in Awaiting Additional Information status
ParticipantAccessRights enum<string>

AccessAttributes Enumeration values is used to determine whether participant has access to particular feature / functionality / page.

Possible values: None AllowParticipantClaimEntry AllowParticipantReceiptUpload AllowParticipantPayProvider AllowParticipantEmailUpdates AllowParticipantEmailAdmin AllowParticipantAccessDependentInfo AllowParticipantRequestNewCard AllowParticipantUpdateDemoInfo AllowParticipantUpdateDirectDepositInfo AllowParticipantViewDirectDepositInfo AllowParticipantClaimsCrossOver AllowParticipantCommunicationSelection AllowEmpeSelfCreation AllowParticipantUpdateAutoReimbSettings AllowParticipantAddDependent AllowParticipantLinkDependentAccount AllowParticipantCreateDependentCard AllowParticipantRequireDependentDOBSSN AllowParticipantCardReimbursement IsEligibleEnroll GetAcctClassification GetInnoPartners GetParticipantPortalAccessInfo EmployerNoDebitCard DirectDepositBankAccountValidation AllowParticipantOnlineRepayment AllowOfflineSAAuthenticationToken AllowSAFeatureOnOff
InnoPartnerIds array <string>

Displays a list of Innovation Partner IDs that are enabled for a participant. Innovation partners are controlled by Alegeus and include vendors like FSA Store, HSA Store, etc. This value will be null if no innovation partners are enabled for this participant.
AcctTypeClasses array <object>

If GetAcctClassification is a requested attribute, this will be populated with the account types which the participant can see. Valid values are FSA, HRA, HSA, VEBA, Deductible, Transit, Parking and Other. If GetAcctClassification is not requested, this will be null.
- Description string
  
  Account type class information, valid values are FSA, HRA, HSA, VEBA, Deductible, Transit, Parking and Other.
- HasType boolean
  
  Determines specified account type class exists or not, value can be True or False.