Participant APIs | REST

Selected Version:
Download Open API File

Send a verification code using SMS to a mobile number for the user to validate.

https://api.wealthcare.com/participant/registration/sendCodeSMS

Sends a verification code via SMS to the specified mobile number, allowing the user to validate their identity during the registration process.

Request

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

  • TpaId string
    Min Length: 0
    Max Length: 6
  • EmployerId string
    Min Length: 0
    Max Length: 18
  • EmployeeId string
    Min Length: 0
    Max Length: 255
  • MobileNumber string
    Min Length: 0
    Max Length: 30
  • Email string
    Min Length: 0
    Max Length: 75
  • IPAddress string
    Min Length: 0
    Max Length: 75
  • PortfolioId string
    Min Length: 0
    Max Length: 75
  • HardwareId string
    Min Length: 0
    Max Length: 75
  • RequestFrom enum<string>
    Possible values: WCA WCP WCM
  • TpaId string
    Min Length: 0
    Max Length: 6
  • EmployerId string
    Min Length: 0
    Max Length: 18
  • EmployeeId string
    Min Length: 0
    Max Length: 255
  • MobileNumber string
    Min Length: 0
    Max Length: 30
  • Email string
    Min Length: 0
    Max Length: 75
  • IPAddress string
    Min Length: 0
    Max Length: 75
  • PortfolioId string
    Min Length: 0
    Max Length: 75
  • HardwareId string
    Min Length: 0
    Max Length: 75
  • RequestFrom enum<string>
    Possible values: WCA WCP WCM

Response

  • RSAId string
  • TransactionId string
  • RSAId string
  • TransactionId string
Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...