# OnDemandClient.DefaultApi

All URIs are relative to *https://api-int.kennect.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**billingCodesGet**](DefaultApi.md#billingCodesGet) | **GET** /billing-codes | Get a list of valid billing codes
[**candidatesGet**](DefaultApi.md#candidatesGet) | **GET** /candidates | Get a list of Candidates
[**candidatesIdDocumentsGet**](DefaultApi.md#candidatesIdDocumentsGet) | **GET** /candidates/{id}/documents | List documents attached to a candidate
[**candidatesIdDocumentsPost**](DefaultApi.md#candidatesIdDocumentsPost) | **POST** /candidates/{id}/documents | Attach a document to a candidate
[**candidatesIdGet**](DefaultApi.md#candidatesIdGet) | **GET** /candidates/{id} | Get a specific Candidate
[**candidatesIdLinksPost**](DefaultApi.md#candidatesIdLinksPost) | **POST** /candidates/{id}/links | Get links to the Candidate portal for use by the Candidate
[**candidatesIdPut**](DefaultApi.md#candidatesIdPut) | **PUT** /candidates/{id} | Update a candidate
[**candidatesIdTrustPost**](DefaultApi.md#candidatesIdTrustPost) | **POST** /candidates/{id}/trust | Trust a candidate
[**candidatesPost**](DefaultApi.md#candidatesPost) | **POST** /candidates | Create a candidate
[**chargesPost**](DefaultApi.md#chargesPost) | **POST** /charges | Create a capture
[**healthGet**](DefaultApi.md#healthGet) | **GET** /health | Check the health of the API
[**identitiesIdGet**](DefaultApi.md#identitiesIdGet) | **GET** /identities/{id} | Get a verified identity
[**identitiesIdRetryPost**](DefaultApi.md#identitiesIdRetryPost) | **POST** /identities/{id}/retry | Retry creating an identity and get a new set of questions
[**identitiesIdVerificationPut**](DefaultApi.md#identitiesIdVerificationPut) | **PUT** /identities/{id}/verification | Verify an identity by providing correct answers
[**identitiesPost**](DefaultApi.md#identitiesPost) | **POST** /identities | Get a list of questions needing to be answered before an identity can be created
[**packagesGet**](DefaultApi.md#packagesGet) | **GET** /packages | Get a list of Packages
[**packagesIdPriceGet**](DefaultApi.md#packagesIdPriceGet) | **GET** /packages/{id}/price | Get the estimated price of a Package
[**referenceCodesGet**](DefaultApi.md#referenceCodesGet) | **GET** /reference-codes | Return a list of valid Reference Codes
[**screeningsIdAdverseActionsPost**](DefaultApi.md#screeningsIdAdverseActionsPost) | **POST** /screenings/{id}/adverse-actions | Create an adverse action on a Screening
[**screeningsIdDetailsGet**](DefaultApi.md#screeningsIdDetailsGet) | **GET** /screenings/{id}/details | Get a specific screening
[**screeningsIdDocumentsAttachmentIdGet**](DefaultApi.md#screeningsIdDocumentsAttachmentIdGet) | **GET** /screenings/{id}/documents/{attachmentId} | Get a Screening attachment in PDF form
[**screeningsIdDocumentsGet**](DefaultApi.md#screeningsIdDocumentsGet) | **GET** /screenings/{id}/documents | 
[**screeningsIdDocumentsPost**](DefaultApi.md#screeningsIdDocumentsPost) | **POST** /screenings/{id}/documents | Attach a document to a Screening
[**screeningsIdGet**](DefaultApi.md#screeningsIdGet) | **GET** /screenings/{id} | Get a specific screening
[**screeningsIdInvitePost**](DefaultApi.md#screeningsIdInvitePost) | **POST** /screenings/{id}/invite | Create an invite
[**screeningsIdReportGet**](DefaultApi.md#screeningsIdReportGet) | **GET** /screenings/{id}/report | Get a Screening report in PDF form
[**screeningsIdReportLinksPost**](DefaultApi.md#screeningsIdReportLinksPost) | **POST** /screenings/{id}/report-links | Create  a one-time use report link
[**screeningsIdReportPdfGet**](DefaultApi.md#screeningsIdReportPdfGet) | **GET** /screenings/{id}/report.pdf | Get a Screening report in PDF form
[**screeningsPost**](DefaultApi.md#screeningsPost) | **POST** /screenings | Create a Screening
[**subscriptionsIdDelete**](DefaultApi.md#subscriptionsIdDelete) | **DELETE** /subscriptions/{id} | Delete a subscription
[**subscriptionsIdEventsGet**](DefaultApi.md#subscriptionsIdEventsGet) | **GET** /subscriptions/{id}/events | Get a list of events related to a given subscription
[**subscriptionsIdGet**](DefaultApi.md#subscriptionsIdGet) | **GET** /subscriptions/{id} | Get a subscription
[**subscriptionsPost**](DefaultApi.md#subscriptionsPost) | **POST** /subscriptions | Create a subscription
[**tokensPost**](DefaultApi.md#tokensPost) | **POST** /tokens | Creates a temporary access token
[**trustedUsersIdGet**](DefaultApi.md#trustedUsersIdGet) | **GET** /trusted-users/{id} | Get trust information about a verified user
[**trustedUsersPost**](DefaultApi.md#trustedUsersPost) | **POST** /trusted-users | Trust a verified user
[**trustsIdDelete**](DefaultApi.md#trustsIdDelete) | **DELETE** /trusts/{id} | Untrust a Trusted User


<a name="billingCodesGet"></a>
# **billingCodesGet**
> BillingCodesResponse billingCodesGet()

Get a list of valid billing codes

Get a list of valid billing codes

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**BillingCodesResponse**](BillingCodesResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesGet"></a>
# **candidatesGet**
> [CandidateResponse] candidatesGet(opts)

Get a list of Candidates

Get a list of Candidates

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var opts = { 
  'limit': "limit_example", // String | 
  'offset': "offset_example", // String | 
  'givenName': "givenName_example", // String | 
  'familyName': "familyName_example", // String | 
  'clientReferenceId': "clientReferenceId_example", // String | 
  'email': "email_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **String**|  | [optional] 
 **offset** | **String**|  | [optional] 
 **givenName** | **String**|  | [optional] 
 **familyName** | **String**|  | [optional] 
 **clientReferenceId** | **String**|  | [optional] 
 **email** | **String**|  | [optional] 

### Return type

[**[CandidateResponse]**](CandidateResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesIdDocumentsGet"></a>
# **candidatesIdDocumentsGet**
> [CandidateDocumentResponse] candidatesIdDocumentsGet(id)

List documents attached to a candidate

List documents attached to a candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**[CandidateDocumentResponse]**](CandidateDocumentResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesIdDocumentsPost"></a>
# **candidatesIdDocumentsPost**
> candidatesIdDocumentsPost(id, opts)

Attach a document to a candidate

Attach a document to a candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var opts = { 
  'contentType': "contentType_example", // String | 
  'fileName': "fileName_example", // String | 
  'body': B // Blob | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.candidatesIdDocumentsPost(id, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **contentType** | **String**|  | [optional] 
 **fileName** | **String**|  | [optional] 
 **body** | **Blob**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/octet-stream
 - **Accept**: application/json

<a name="candidatesIdGet"></a>
# **candidatesIdGet**
> CandidateResponse candidatesIdGet(id)

Get a specific Candidate

Get a specific Candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**CandidateResponse**](CandidateResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesIdLinksPost"></a>
# **candidatesIdLinksPost**
> CandidatePortalLinkResponse candidatesIdLinksPost(id)

Get links to the Candidate portal for use by the Candidate

Get links to the Candidate portal for use by the Candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**CandidatePortalLinkResponse**](CandidatePortalLinkResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesIdPut"></a>
# **candidatesIdPut**
> CandidateResponse candidatesIdPut(id, candidateRequest)

Update a candidate

Update a candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var candidateRequest = new OnDemandClient.CandidateRequest(); // CandidateRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.candidatesIdPut(id, candidateRequest, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **candidateRequest** | [**CandidateRequest**](CandidateRequest.md)|  | 

### Return type

[**CandidateResponse**](CandidateResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesIdTrustPost"></a>
# **candidatesIdTrustPost**
> TrustedUserResponse candidatesIdTrustPost(id, trustedUserRequest)

Trust a candidate

Trust a candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var trustedUserRequest = new OnDemandClient.TrustedUserRequest(); // TrustedUserRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.candidatesIdTrustPost(id, trustedUserRequest, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **trustedUserRequest** | [**TrustedUserRequest**](TrustedUserRequest.md)|  | 

### Return type

[**TrustedUserResponse**](TrustedUserResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="candidatesPost"></a>
# **candidatesPost**
> CandidateResponse candidatesPost(candidateRequest)

Create a candidate

Create a candidate

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var candidateRequest = new OnDemandClient.CandidateRequest(); // CandidateRequest | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **candidateRequest** | [**CandidateRequest**](CandidateRequest.md)|  | 

### Return type

[**CandidateResponse**](CandidateResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="chargesPost"></a>
# **chargesPost**
> ChargeResponse chargesPost(chargeRequest)

Create a capture

Create a capture

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var chargeRequest = new OnDemandClient.ChargeRequest(); // ChargeRequest | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chargeRequest** | [**ChargeRequest**](ChargeRequest.md)|  | 

### Return type

[**ChargeResponse**](ChargeResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="healthGet"></a>
# **healthGet**
> HealthResponse healthGet(opts)

Check the health of the API

Check the health of the API

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var opts = { 
  'deep': "deep_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deep** | **String**|  | [optional] 

### Return type

[**HealthResponse**](HealthResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="identitiesIdGet"></a>
# **identitiesIdGet**
> IdentityResponse identitiesIdGet(id)

Get a verified identity

Get a verified identity

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**IdentityResponse**](IdentityResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="identitiesIdRetryPost"></a>
# **identitiesIdRetryPost**
> IdentityResponse identitiesIdRetryPost(id)

Retry creating an identity and get a new set of questions

Retry creating an identity and get a new set of questions

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**IdentityResponse**](IdentityResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="identitiesIdVerificationPut"></a>
# **identitiesIdVerificationPut**
> IdentityResponse identitiesIdVerificationPut(id, verificationRequest)

Verify an identity by providing correct answers

Verify an identity by providing correct answers

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var verificationRequest = new OnDemandClient.VerificationRequest(); // VerificationRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.identitiesIdVerificationPut(id, verificationRequest, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **verificationRequest** | [**VerificationRequest**](VerificationRequest.md)|  | 

### Return type

[**IdentityResponse**](IdentityResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="identitiesPost"></a>
# **identitiesPost**
> IdentityResponse identitiesPost(identityRequest)

Get a list of questions needing to be answered before an identity can be created

Get a list of questions needing to be answered before an identity can be created

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var identityRequest = new OnDemandClient.IdentityRequest(); // IdentityRequest | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **identityRequest** | [**IdentityRequest**](IdentityRequest.md)|  | 

### Return type

[**IdentityResponse**](IdentityResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="packagesGet"></a>
# **packagesGet**
> [PackageResponse] packagesGet(opts)

Get a list of Packages

Get a list of Packages

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var opts = { 
  'all': "all_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **all** | **String**|  | [optional] 

### Return type

[**[PackageResponse]**](PackageResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="packagesIdPriceGet"></a>
# **packagesIdPriceGet**
> PackagePriceResponse packagesIdPriceGet(id, candidateId)

Get the estimated price of a Package

Get the estimated price of a Package

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var candidateId = "candidateId_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.packagesIdPriceGet(id, candidateId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **candidateId** | **String**|  | 

### Return type

[**PackagePriceResponse**](PackagePriceResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="referenceCodesGet"></a>
# **referenceCodesGet**
> ReferenceCodesResponse referenceCodesGet()

Return a list of valid Reference Codes

Return a list of valid Reference Codes

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**ReferenceCodesResponse**](ReferenceCodesResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdAdverseActionsPost"></a>
# **screeningsIdAdverseActionsPost**
> screeningsIdAdverseActionsPost(id, adverseActionRequest)

Create an adverse action on a Screening

Create an adverse action on a Screening

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var adverseActionRequest = new OnDemandClient.AdverseActionRequest(); // AdverseActionRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.screeningsIdAdverseActionsPost(id, adverseActionRequest, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **adverseActionRequest** | [**AdverseActionRequest**](AdverseActionRequest.md)|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdDetailsGet"></a>
# **screeningsIdDetailsGet**
> [ScreeningDetailsResponse] screeningsIdDetailsGet(id)

Get a specific screening

Get a specific screening

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**[ScreeningDetailsResponse]**](ScreeningDetailsResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdDocumentsAttachmentIdGet"></a>
# **screeningsIdDocumentsAttachmentIdGet**
> &#39;Blob&#39; screeningsIdDocumentsAttachmentIdGet(id, attachmentId, accept)

Get a Screening attachment in PDF form

Get a Screening attachment in PDF form

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var attachmentId = "attachmentId_example"; // String | 

var accept = "accept_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.screeningsIdDocumentsAttachmentIdGet(id, attachmentId, accept, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **attachmentId** | **String**|  | 
 **accept** | **String**|  | 

### Return type

**&#39;Blob&#39;**

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdDocumentsGet"></a>
# **screeningsIdDocumentsGet**
> [CandidateDocumentResponse] screeningsIdDocumentsGet(id)





### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**[CandidateDocumentResponse]**](CandidateDocumentResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdDocumentsPost"></a>
# **screeningsIdDocumentsPost**
> screeningsIdDocumentsPost(id, documentType, party, opts)

Attach a document to a Screening

Attach a document to a Screening

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var documentType = "documentType_example"; // String | 

var party = "party_example"; // String | 

var opts = { 
  'contentType': "contentType_example", // String | 
  'body': B // Blob | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.screeningsIdDocumentsPost(id, documentType, party, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **documentType** | **String**|  | 
 **party** | **String**|  | 
 **contentType** | **String**|  | [optional] 
 **body** | **Blob**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/octet-stream
 - **Accept**: application/json

<a name="screeningsIdGet"></a>
# **screeningsIdGet**
> ScreeningResponse screeningsIdGet(id)

Get a specific screening

Get a specific screening

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**ScreeningResponse**](ScreeningResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdInvitePost"></a>
# **screeningsIdInvitePost**
> InviteResponse screeningsIdInvitePost(id)

Create an invite

Create an invite

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**InviteResponse**](InviteResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdReportGet"></a>
# **screeningsIdReportGet**
> &#39;Blob&#39; screeningsIdReportGet(id, accept)

Get a Screening report in PDF form

Get a Screening report in PDF form

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var accept = "accept_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.screeningsIdReportGet(id, accept, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **accept** | **String**|  | 

### Return type

**&#39;Blob&#39;**

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdReportLinksPost"></a>
# **screeningsIdReportLinksPost**
> OneTimeReportLinkResponse screeningsIdReportLinksPost(id)

Create  a one-time use report link

Create  a one-time use report link

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**OneTimeReportLinkResponse**](OneTimeReportLinkResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsIdReportPdfGet"></a>
# **screeningsIdReportPdfGet**
> &#39;Blob&#39; screeningsIdReportPdfGet(id, opts)

Get a Screening report in PDF form

Get a Screening report in PDF form

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 

var opts = { 
  'token': "token_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **token** | **String**|  | [optional] 

### Return type

**&#39;Blob&#39;**

### Authorization

No authorization required

### HTTP request headers

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

<a name="screeningsPost"></a>
# **screeningsPost**
> ScreeningResponse screeningsPost(screeningRequest, opts)

Create a Screening

Create a Screening

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var screeningRequest = new OnDemandClient.ScreeningRequest(); // ScreeningRequest | 

var opts = { 
  'idempotencyKey': "idempotencyKey_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **screeningRequest** | [**ScreeningRequest**](ScreeningRequest.md)|  | 
 **idempotencyKey** | **String**|  | [optional] 

### Return type

[**ScreeningResponse**](ScreeningResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="subscriptionsIdDelete"></a>
# **subscriptionsIdDelete**
> SubscriptionResponse subscriptionsIdDelete(id)

Delete a subscription

Delete a subscription

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="subscriptionsIdEventsGet"></a>
# **subscriptionsIdEventsGet**
> SubscriptionEventsResponse subscriptionsIdEventsGet(id)

Get a list of events related to a given subscription

Get a list of events related to a given subscription

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**SubscriptionEventsResponse**](SubscriptionEventsResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="subscriptionsIdGet"></a>
# **subscriptionsIdGet**
> SubscriptionResponse subscriptionsIdGet(id)

Get a subscription

Get a subscription

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="subscriptionsPost"></a>
# **subscriptionsPost**
> SubscriptionResponse subscriptionsPost(subscriptionRequest)

Create a subscription

Create a subscription

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var subscriptionRequest = new OnDemandClient.SubscriptionRequest(); // SubscriptionRequest | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **subscriptionRequest** | [**SubscriptionRequest**](SubscriptionRequest.md)|  | 

### Return type

[**SubscriptionResponse**](SubscriptionResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="tokensPost"></a>
# **tokensPost**
> TokenResponse tokensPost(tokenRequest)

Creates a temporary access token

Creates a temporary access token

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var tokenRequest = new OnDemandClient.TokenRequest(); // TokenRequest | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tokenRequest** | [**TokenRequest**](TokenRequest.md)|  | 

### Return type

[**TokenResponse**](TokenResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="trustedUsersIdGet"></a>
# **trustedUsersIdGet**
> TrustedUserResponse trustedUsersIdGet(id)

Get trust information about a verified user

Get trust information about a verified user

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

[**TrustedUserResponse**](TrustedUserResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="trustedUsersPost"></a>
# **trustedUsersPost**
> TrustedUserResponse trustedUsersPost(trustedUserRequest)

Trust a verified user

Trust a verified user

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var trustedUserRequest = new OnDemandClient.TrustedUserRequest(); // TrustedUserRequest | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **trustedUserRequest** | [**TrustedUserRequest**](TrustedUserRequest.md)|  | 

### Return type

[**TrustedUserResponse**](TrustedUserResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="trustsIdDelete"></a>
# **trustsIdDelete**
> trustsIdDelete(id)

Untrust a Trusted User

Untrust a Trusted User

### Example
```javascript
var OnDemandClient = require('on-demand-client');

var apiInstance = new OnDemandClient.DefaultApi();

var id = "id_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.trustsIdDelete(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined