# VmosoApi.OnBoardingApi

All URIs are relative to *https://www.vmoso.com/svc*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getOnBoardingInfo**](OnBoardingApi.md#getOnBoardingInfo) | **GET** /onboarding | 


<a name="getOnBoardingInfo"></a>
# **getOnBoardingInfo**
> GetOnBoardingInfoResult getOnBoardingInfo(opts)



Use this API to get onboarding information.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.OnBoardingApi()

var opts = { 
  'tz': 3.4 // {Number} Not needed.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOnBoardingInfo(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tz** | [**Number**](.md)| Not needed. | [optional] 

### Return type

[**GetOnBoardingInfoResult**](GetOnBoardingInfoResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json