Participant APIs | REST

Version:

Download Open API Specification

Get card pin

https://beta.api.wealthcare.com/participant/services/participant/cards/pin/{tpaId}/{employerId}/{participantId}

Get Card Pin - Display's the participant's pin for current issued card.

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

card string Required

The proxy number of the card. This can be retrieved on the Get Card Summary API.
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.
asText integer <int32>

Indicate if the pin is return as an image or an integer. 0: pin returned as image, 1: pin returned as text, default to 0.