new module:model/AuthenticationStatus()
- Source:
Constructs a new AuthenticationStatus.
Contains information about the authentication status.
Members
(inner) accessCodeResult :module:model/EventResult
- Source:
The result of a user's attempt to authenticate by using an access code. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) ageVerifyResult :module:model/EventResult
- Source:
The result of an age verification check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) anySocialIDResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) facebookResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) googleResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) identityVerificationResult :module:model/EventResult
- Source:
The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/
Type:
(inner) idLookupResult :module:model/EventResult
- Source:
The result of an ID lookup authentication check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) idQuestionsResult :module:model/EventResult
- Source:
The result of the user's answers to ID challenge questions. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) linkedinResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) liveIDResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) ofacResult :module:model/EventResult
- Source:
The result of an Office of Foreign Asset Control (OFAC) check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) openIDResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) phoneAuthResult :module:model/EventResult
- Source:
The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) salesforceResult :module:model/EventResult
- Source:
Success/failure result of authentication using sign-in with a Salesforce account. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) signatureProviderResult :module:model/EventResult
- Source:
The result of the user's attempt to authenticate by using a signature provider.
Type:
(inner) smsAuthResult :module:model/EventResult
- Source:
The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
Type:
(inner) sTANPinResult :module:model/EventResult
- Source:
The result of a Student Authentication Network (STAN) authentication check. It returns: - Status: Pass or Fail. - dateTime: The date and time that the event occurred. - FailureDescription: A string containing the details about a failed authentication. - VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.
Type:
(inner) twitterResult :module:model/EventResult
- Source:
Deprecated.
Type:
(inner) yahooResult :module:model/EventResult
- Source:
Deprecated.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/AuthenticationStatus}
- Source:
Constructs a AuthenticationStatus from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/AuthenticationStatus | Optional instance to populate. |
Returns:
The populated AuthenticationStatus instance.