Model2FAResponseData.md

CircleAuth.Model2FAResponseData

Properties

Name	Type	Description	Notes
factorUrl	String	The URL that will open Circle Auth website or the app to request the user acceptance. Check Factor Authentication). acceptance.
customID	String	The customID parameter can be anything to track back to your system. Example: `session-123`
returnUrl	String	The return URL that will be used for redirection when the 2FA is accepted.
webhookUrl	String	Webhook URL to send data when 2FA is accepted. Check out 2FA Webhook for request specification.	[optional]
phone	String	The phone number that you want the acceptance of the question. <br>Must start with `+` (plus sign) and the country code. <br>You cannot send the `email` and the `phone`, you have to send one or another.	[optional]
email	String	The e-mail address that you want the acceptance of the question. <br>You cannot send the `email` and the `phone`, you have to send one or another.	[optional]
question	String	This is the question you will make to the user. Example: `Confirm 1 BTC withdrawal?`	[optional]
userID	String	The userID that you want the acceptance of the question. <br>If the user that scans the code is not the same as this `userID`, he will not be able to accept your question. <br>You don't need this parameter if you use the `email` or `phone`. But if you add this parameter, both checks (`userID` plus `email`/`phone`) will happen.	[optional]
mobileReturnUrl	String	This URL, with the same parameters as the `returnUrl` or `webhookUrl`, will be triggered by the user's app after his factor acceptance. This is usually done when making an app-to-app call. You can use, for example, `your_app://path` (Deep Link).	[optional]