# ESignPublicApi

All URIs are relative to *http://localhost:8081*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**decline**](#decline) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope)|
|[**document**](#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing|
|[**markViewed**](#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document|
|[**requestOtp**](#requestotp) | **POST** /api/v1/public/signatures/otp/request | Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)|
|[**sign**](#sign) | **POST** /api/v1/public/signatures/sign | Submit the recipient\'s fields and sign|
|[**verifyOtp**](#verifyotp) | **POST** /api/v1/public/signatures/otp/verify | Verify the one-time access code|
|[**view**](#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view|

# **decline**
> PublicSignatureView decline()


### Example

```typescript
import {
    ESignPublicApi,
    Configuration,
    DeclineSignatureRequest
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)
let declineSignatureRequest: DeclineSignatureRequest; // (optional)

const { status, data } = await apiInstance.decline(
    token,
    declineSignatureRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **declineSignatureRequest** | **DeclineSignatureRequest**|  | |
| **token** | [**string**] |  | defaults to undefined|


### Return type

**PublicSignatureView**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **document**
> File document()


### Example

```typescript
import {
    ESignPublicApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)

const { status, data } = await apiInstance.document(
    token
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **token** | [**string**] |  | defaults to undefined|


### Return type

**File**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **markViewed**
> PublicSignatureView markViewed()


### Example

```typescript
import {
    ESignPublicApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)
let userAgent: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.markViewed(
    token,
    userAgent
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **token** | [**string**] |  | defaults to undefined|
| **userAgent** | [**string**] |  | (optional) defaults to undefined|


### Return type

**PublicSignatureView**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **requestOtp**
> requestOtp()


### Example

```typescript
import {
    ESignPublicApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)

const { status, data } = await apiInstance.requestOtp(
    token
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **token** | [**string**] |  | defaults to undefined|


### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**202** | Accepted |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **sign**
> PublicSignatureView sign(applySignatureRequest)


### Example

```typescript
import {
    ESignPublicApi,
    Configuration,
    ApplySignatureRequest
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)
let applySignatureRequest: ApplySignatureRequest; //
let userAgent: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.sign(
    token,
    applySignatureRequest,
    userAgent
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **applySignatureRequest** | **ApplySignatureRequest**|  | |
| **token** | [**string**] |  | defaults to undefined|
| **userAgent** | [**string**] |  | (optional) defaults to undefined|


### Return type

**PublicSignatureView**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **verifyOtp**
> PublicSignatureView verifyOtp(verifyOtpRequest)


### Example

```typescript
import {
    ESignPublicApi,
    Configuration,
    VerifyOtpRequest
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)
let verifyOtpRequest: VerifyOtpRequest; //

const { status, data } = await apiInstance.verifyOtp(
    token,
    verifyOtpRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **verifyOtpRequest** | **VerifyOtpRequest**|  | |
| **token** | [**string**] |  | defaults to undefined|


### Return type

**PublicSignatureView**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **view**
> PublicSignatureView view()


### Example

```typescript
import {
    ESignPublicApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignPublicApi(configuration);

let token: string; // (default to undefined)

const { status, data } = await apiInstance.view(
    token
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **token** | [**string**] |  | defaults to undefined|


### Return type

**PublicSignatureView**

### Authorization

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

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)