AI Assistant

Participant APIs | REST

Version:
Download Open API Specification

Issue new card

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

This endpoint issues a new card for an employee or dependent, ensuring that no other card is in a new status for the same individual.

  • 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.

  • Accept-Language enum<string>

    Indicates the participant’s preferred language for the response. Valid options are "es" for Spanish, "en" for English, and "fr" for French. If an invalid value is provided, the response defaults to English.

    Possible values: es en fr
  • dep string

    The unique identifier for the dependent. Include this parameter if the card is being issued for a dependent rather than the employee.

  • status integer <int32>

    Specifies the status of the card being issued. Defaults to 5 (Lost/Stolen) if not provided.

  • 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.

  • 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