Participant APIs | REST

Version:
Download Open API Specification

Issue new card

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

This API is used to issue a new card for an employee or dependent. The card will be issued in a new status. An employee or dependent can only have one card in a new status; this API will return an error if a card is requested for someone that already has a card in a new status. The existing new card must be updated to a different status (I.e., Lost/Stolen) before a new card may be issued.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with 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

    Participant Id

  • Accept-Language enum<string>

    Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

    Possible values: es en fr
  • dep string

    Dependent ID - send this if the card is to be issued for a dependent.

  • status integer <int32>

    The status of a card, default to 5(LostStolen)

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • EmployeeId string

    The EmployeeId of the card of the employee/dependent

  • DependentId string

    The DependentId of the card. Null if the card belongs to an employee

  • CardLast4Digits string

    The last four digits of the card

  • CardProxyNumber string

    For security purposes, a 16-digit proxy number is used to represent the card instead of the actual card number

  • CardStatusCode enum<string>

    The card status code: New = 1, Active = 2, TempInactive = 3, PermInactive = 4, LostStolen = 5

    Possible values: All New Active TempInactive PermInactive LostStolen
  • NamePrefix string

    The prefix of cardholder's name. Valid values are Mr., Mrs., Ms., Dr., and Rev.

  • FirstName string

    The cardholder's first name

  • MiddleInitial string

    The cardholder's middle name initial

  • LastName string

    The cardholder's last name

  • MailedDate string

    Card Mailed Date in YYYYMMDD format

  • CardIssueCde integer

    Card Issue Status Code: DoNotIssue = 1, Issue = 2, Sent = 3, Conditional = 4, Mailed = 5, Waiting = 6