# Is Authorised

# Usage

Query the agents authorisation status.

# Syntax

webclient.isAuthorised(payload: Object): Promise

# Sample Javascript

import IpscapeWebClient from '@ipscape/web-client';

// Instantiate a new instance of the IpSCAPE Web Client
const webClient = new IpscapeWebClient();

// Make request
webclient.isAuthorised().then((response) => {
  if(response.success) {
    alert(response.result);
  }
  else {
    console.error(response.error);
  }
});

# Response

This method returns a promise. The resolved response is returned in an object and contains the following:

Result

Example success Response

Returns this object if the API method call was invoked successfully, false otherwise.

{
    success: boolean;
    result: {
        authorised: boolean;
        timestamp: number;
    };
}