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://beta.api.wealthcare.com/participant/registration/sendCodeSMS

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

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

  • Api-Version string

    The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

    Value: 29.0
  • 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
https://beta.api.wealthcare.com/participant/registration/sendCodeSMS
Change Stored Access Token
The access token of the currently logged in user will be used to send this request
Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.
The version of this operation to be used by this request. Note: Forgetting to include this header will result in the API using version 0.0.

Response

Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...