This method checks the status of ValidID as to whether or not it is enabled. This should be used prior to ActivateValidId to ensure you do not try to activate ValidID when it is already active. This method would only be usually used once for that purpose, but can be used to retrieve the signed agreement.
If it is not activated the method will return the agreement text for the user to accept. Therefore this needs to be called prior to calling the ActivateValidId to get the agreement to show to the user or they will not know what they are agreeing to.
Request Parameters
None required besides Authentication
Response Parameters
Parameter | Type | Format | Description |
---|---|---|---|
ResponseStatus | ResponseStatus | Instance of ResponseStatus object (see here) | |
AgreementText | String | The text of the agreement, including the details on when it was signed if applicable | |
ValidIdActivated | Bool | True, if ValidID has been activated on the account |