### Install boldsign SDK

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/README.md

Install the boldsign Node.js SDK using npm. Ensure you have Node.js 12 or higher.

```bash
npm install boldsign
```

--------------------------------

### GET /v1/users/get

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/UserApi.md

Get summary of the user.

```APIDOC
## GET /v1/users/get

### Description
Get summary of the user.

### Method
GET

### Endpoint
/v1/users/get

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user to retrieve.

### Response
#### Success Response (200)
- **UserSummary** - An object containing the summary of the user.

#### Response Example
```json
{
  "id": "user-id-123",
  "email": "user@example.com",
  "role": "Admin",
  "teamId": "your-team-id",
  "status": "Active"
}
```
```

--------------------------------

### GET /v1/users/list

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/UserApi.md

List user documents.

```APIDOC
## GET /v1/users/list

### Description
List user documents.

### Method
GET

### Endpoint
/v1/users/list

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **UserList** - A list of user objects.

#### Response Example
```json
{
  "users": [
    {
      "id": "user-id-123",
      "email": "user@example.com",
      "role": "Admin",
      "teamId": "your-team-id",
      "status": "Active"
    },
    {
      "id": "user-id-456",
      "email": "anotheruser@example.com",
      "role": "Member",
      "teamId": "your-team-id",
      "status": "Active"
    }
  ],
  "totalCount": 2
}
```
```

--------------------------------

### Get Template Properties

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TemplateApi.md

Retrieves a summary of a specific template by its ID.

```APIDOC
## GET /api/templates/{templateId}

### Description
Get summary of the template.

### Method
GET

### Endpoint
/api/templates/{templateId}

### Parameters
#### Path Parameters
- **templateId** (string) - Required - Template Id.

### Response
#### Success Response (200)
- **TemplateProperties** (object) - Details about the template.

#### Response Example
{
  "example": "TemplateProperties object"
}
```

--------------------------------

### GET /v1/teams/list

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TeamsApi.md

Lists all available teams, with options for pagination and searching.

```APIDOC
## GET /v1/teams/list

### Description
List Teams.

### Method
GET

### Endpoint
/v1/teams/list

### Parameters
#### Query Parameters
- **page** (number) - Required - Page index specified in get team list request. [default to 1]
- **pageSize** (number) - Optional - Page size specified in get team list request. [default to 10]
- **searchKey** (string) - Optional - Teams can be listed by the search key.

### Response
#### Success Response (200)
- **TeamListResponse** (TeamListResponse) - A list of teams.

#### Response Example
```json
{
  "example": "response body for listTeams"
}
```
```

--------------------------------

### GET /v1/senderIdentities/list

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/SenderIdentitiesApi.md

Lists all available sender identities.

```APIDOC
## GET /v1/senderIdentities/list

### Description
Lists sender identity.

### Method
GET

### Endpoint
/v1/senderIdentities/list

### Response
#### Success Response (200)
- **SenderIdentityList** (SenderIdentityList) - A list of sender identities.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /users

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/UserApi.md

Lists users based on specified criteria such as page number, page size, search query, and a list of user IDs.

```APIDOC
## GET /users

### Description
List user documents.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **page** (number) - Required - Page index specified in get user list request. [default to 1]
- **pageSize** (number) - Optional - Page size specified in get user list request. [default to 10]
- **search** (string) - Optional - Users can be listed by the search based on the user ID.
- **userId** (Array<string>) - Optional - Users can be listed by the search based on the user IDs.

### Response
#### Success Response (200)
- **UserRecords** (UserRecords) - Records of users.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
```

--------------------------------

### POST /v1/users/create

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/UserApi.md

Create the user.

```APIDOC
## POST /v1/users/create

### Description
Create the user.

### Method
POST

### Endpoint
/v1/users/create

### Parameters
#### Request Body
- **createUser** (Array<CreateUser>) - Required - An array of user objects to create.

### Request Example
```json
[
  {
    "email": "user@example.com",
    "role": "Admin",
    "teamId": "your-team-id"
  }
]
```

### Response
#### Success Response (200)
- **Array<User>** - A list of the created user objects.

#### Response Example
```json
[
  {
    "id": "user-id-123",
    "email": "user@example.com",
    "role": "Admin",
    "teamId": "your-team-id",
    "status": "Active"
  }
]
```
```

--------------------------------

### GET /v1/contactGroups/get - Get Group Contact

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/GroupContactsApi.md

Retrieves the summary details of a specific group contact.

```APIDOC
## GET /v1/contactGroups/get

### Description
Get Summary of the Group Contact.

### Method
GET

### Endpoint
/v1/contactGroups/get

### Parameters
#### Query Parameters
- **groupId** (string) - Required - The group contact id.

### Response
#### Success Response (200)
- **result** (GetGroupContactDetails) - The response object containing the group contact details.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
- **Accept**: `application/json`
```

--------------------------------

### API Endpoints Overview

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/README.md

A list of available API endpoints for managing Boldsign resources.

```APIDOC
## API Endpoints

This SDK provides access to various Boldsign functionalities through the following modules:

- IdentityVerificationSettings
- ImageInfo
- MergeAndSendForSignForm
- ModelDate
- ModelError
- ModificationDetails
- NotificationSettings
- PageDetails
- PhoneNumber
- PrefillField
- PrefillFieldRequest
- RecipientChangeLog
- RecipientNotificationSettings
- Rectangle
- ReminderMessage
- ReminderSettings
- RemoveAuthentication
- Removed
- RevokeDocument
- Role
- Roles
- SendForSign
- SendForSignFromTemplateForm
- SenderIdentityCreated
- SenderIdentityList
- SenderIdentityViewModel
- SignatureFrameSettings
- SignerAuthenticationSettings
- Size
- TeamCreated
- TeamDocumentRecords
- TeamListResponse
- TeamPageDetails
- TeamResponse
- TeamUpdateRequest
- TeamUsers
- Teams
- Template
- TemplateCC
- TemplateCreated
- TemplateFiles
- TemplateFormFields
- TemplateGroupSigner
- TemplateProperties
- TemplateRecords
- TemplateRole
- TemplateSenderDetail
- TemplateSenderDetails
- TemplateSharedTemplateDetail
- TemplateSharing
- TemplateSignerDetails
- TemplateTag
- TemplateTeamShare
- TextTagDefinition
- TextTagOffset
- UpdateGroupContact
- UpdateUser
- UpdateUserMetaData
- UserPageDetails
- UserProperties
- UserRecords
- UsersDetails
- Validation
- VerificationDataRequest
- ViewBrandDetails
- ViewCustomFieldDetails
```

--------------------------------

### POST /users

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/UserApi.md

This endpoint is used to create a new user within the Boldsign system. It accepts an array of user objects for batch creation.

```APIDOC
## POST /users

### Description
Creates a new user. Accepts an array of `CreateUser` objects.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **createUser** (Array<CreateUser>) - Optional - The create user.

### Response
#### Success Response (200)
void (empty response body)

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json` 
- **Accept**: `application/json`
```

--------------------------------

### POST /createTemplate

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TemplateApi.md

Creates a new template within your Boldsign account.

```APIDOC
## POST /createTemplate

### Description
Creates a new template.

### Method
POST

### Endpoint
/createTemplate

### Parameters
#### Request Body
- **createTemplateRequest** (CreateTemplateRequest) - Optional - The create template request body.

### Response
#### Success Response (200)
- **TemplateCreated** (TemplateCreated) - Details of the newly created template.

### Request Example
```json
{
  "createTemplateRequest": {
    "templateName": "Invoice Template",
    "templateContent": "<html><body><h1>Invoice</h1></body></html>"
  }
}
```

### Response Example
```json
{
  "templateId": "your_new_template_id",
  "templateName": "Invoice Template"
}
```
```

--------------------------------

### GET /v1/contacts/get

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/ContactsApi.md

Retrieves the summary details of a specific contact.

```APIDOC
## GET /v1/contacts/get

### Description
Get summary of the contact.

### Method
GET

### Endpoint
/v1/contacts/get

### Parameters
#### Query Parameters
- **contactId** (string) - Required - The ID of the contact to retrieve.

### Response
#### Success Response (200)
- **contact** (ContactDetails) - The details of the requested contact.

### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john.doe@example.com"
}
```
```

--------------------------------

### POST /v1/contacts/create

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/ContactsApi.md

Creates a new contact in the Boldsign platform.

```APIDOC
## POST /v1/contacts/create

### Description
Create the new Contact.

### Method
POST

### Endpoint
/v1/contacts/create

### Parameters
#### Request Body
- **contactDetails** (Array<ContactDetails>) - Optional - The contact details.

### Request Example
```json
[
  {
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
  }
]
```

### Response
#### Success Response (200)
- **CreateContactResponse** (CreateContactResponse) - Details of the created contact.

### Response Example
```json
{
  "contactIds": [
    "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  ],
  "success": true
}
```
```

--------------------------------

### List Templates

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TemplateApi.md

Lists all available templates with options for filtering and pagination.

```APIDOC
## GET /api/templates

### Description
List all the templates.

### Method
GET

### Endpoint
/api/templates

### Parameters
#### Query Parameters
- **page** (number) - Optional - Current page number. [default to 1]
- **templateType** (string) - Optional - Type of template to list ('mytemplates', 'sharedtemplate', 'all').
- **pageSize** (number) - Optional - Number of templates per page. [default to 10]
- **searchKey** (string) - Optional - Search term for template names.
- **onBehalfOf** (Array<string>) - Optional - Filter templates sent on behalf of specific email addresses.
- **createdBy** (Array<string>) - Optional - Filter templates by creator's email address.
- **templateLabels** (Array<string>) - Optional - Filter templates by labels.
- **startDate** (Date) - Optional - Start date for filtering templates by creation date.
- **endDate** (Date) - Optional - End date for filtering templates by creation date.
- **brandIds** (Array<string>) - Optional - Filter templates by brand IDs.
- **sharedWithTeamId** (Array<string>) - Optional - Filter templates shared with specific team IDs.

### Response
#### Success Response (200)
- **TemplateRecords** (object) - A record containing a list of templates.

#### Response Example
{
  "example": "TemplateRecords object"
}
```

--------------------------------

### Create User

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/UserApi.md

Use this method to create a new user. Accepts an array of CreateUser objects.

```typescript
createUser(createUser: Array<CreateUser>)
```

--------------------------------

### GET /v1/teams/get

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TeamsApi.md

Retrieves the details of a specific team using its ID.

```APIDOC
## GET /v1/teams/get

### Description
Get Team details.

### Method
GET

### Endpoint
/v1/teams/get

### Parameters
#### Query Parameters
- **teamId** (string) - Required - Team Id.

### Response
#### Success Response (200)
- **TeamResponse** (TeamResponse) - Details of the requested team.

#### Response Example
```json
{
  "example": "response body for getTeam"
}
```
```

--------------------------------

### Authentication Methods

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/README.md

Details on how to authenticate your requests using API keys.

```APIDOC
## Authorization

### Bearer

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


### X-API-KEY

- **Type**: API key
- **API key parameter name**: X-API-KEY
- **Location**: HTTP header
```

--------------------------------

### GET /v1/plan/apiCreditsCount

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/PlanApi.md

Retrieves the current API credit details for the account.

```APIDOC
## GET /v1/plan/apiCreditsCount

### Description
Gets the Api credits details.

### Method
GET

### Endpoint
/v1/plan/apiCreditsCount

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

### Response
#### Success Response (200)
- **BillingViewModel** (object) - Details about the billing and API credits.

### Response Example
```json
{
  "credits": 100,
  "planName": "Free Tier",
  "expiryDate": "2024-12-31"
}
```

### Authorization
- X-API-KEY
- Bearer
```

--------------------------------

### HTTP Request Headers

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/CustomFieldApi.md

This section outlines the supported HTTP request headers for the Boldsign Node SDK, focusing on Content-Type and Accept. Proper configuration of these headers ensures that the API correctly interprets the request format and responds appropriately.

```APIDOC
## HTTP Request Headers

### Description
This section details the supported HTTP request headers for the Boldsign Node SDK, primarily focusing on `Content-Type` and `Accept`.

### Headers

#### Content-Type
Specifies the media type of the resource that is being sent to the server. The Boldsign API supports a wide range of JSON and XML formats, as well as plain text.

- **Supported Values**:
  - `application/json;odata.metadata=minimal;odata.streaming=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false`
  - `application/json;odata.metadata=minimal`
  - `application/json;odata.metadata=full;odata.streaming=true`
  - `application/json;odata.metadata=full;odata.streaming=false`
  - `application/json;odata.metadata=full`
  - `application/json;odata.metadata=none;odata.streaming=true`
  - `application/json;odata.metadata=none;odata.streaming=false`
  - `application/json;odata.metadata=none`
  - `application/json;odata.streaming=true`
  - `application/json;odata.streaming=false`
  - `application/json`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=true`
  - `application/json;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;IEEE754Compatible=false`
  - `application/json;IEEE754Compatible=true`
  - `application/xml`
  - `text/plain`
  - `application/json-patch+json`
  - `text/json`
  - `application/*+json`

#### Accept
Indicates the media type(s) that are acceptable for the response. The Boldsign API supports various JSON and XML formats, as well as plain text and binary data.

- **Supported Values**:
  - `application/json;odata.metadata=minimal;odata.streaming=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false`
  - `application/json;odata.metadata=minimal`
  - `application/json;odata.metadata=full;odata.streaming=true`
  - `application/json;odata.metadata=full;odata.streaming=false`
  - `application/json;odata.metadata=full`
  - `application/json;odata.metadata=none;odata.streaming=true`
  - `application/json;odata.metadata=none;odata.streaming=false`
  - `application/json;odata.metadata=none`
  - `application/json;odata.streaming=true`
  - `application/json;odata.streaming=false`
  - `application/json`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=true`
  - `application/json;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;IEEE754Compatible=false`
  - `application/json;IEEE754Compatible=true`
  - `application/xml`
  - `text/plain`
  - `application/octet-stream`
  - `text/json`
```

--------------------------------

### GET /contacts/{id}

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/ContactsApi.md

Retrieves the summary details of a specific contact.

```APIDOC
## GET /contacts/{id}

### Description
Get summary of the contact.

### Method
GET

### Endpoint
/contacts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Contact Id.

### Return type
[**ContactsDetails**](../docs/ContactsDetails.md)

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
```

--------------------------------

### Create User

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/CreateUser.md

This endpoint allows you to create a new user within your Boldsign account. You can specify the user's email, role, and other metadata.

```APIDOC
## POST /api/v1/users

### Description
Creates a new user.

### Method
POST

### Endpoint
/api/v1/users

### Parameters
#### Request Body
- **emailId** (string) - Required - The email address of the user.
- **teamId** (string) - Optional - The ID of the team the user belongs to.
- **userRole** (string) - Optional - The role of the user (e.g., 'Admin', 'Member').
- **metaData** (object) - Optional - Additional metadata for the user. Keys are strings, and values can be strings or null.

### Request Example
```json
{
  "emailId": "user@example.com",
  "teamId": "your_team_id",
  "userRole": "Admin",
  "metaData": {
    "department": "Sales",
    "employeeId": null
  }
}
```

### Response
#### Success Response (201 Created)
- **userId** (string) - The unique identifier for the newly created user.
- **emailId** (string) - The email address of the user.
- **teamId** (string) - The ID of the team the user belongs to.
- **userRole** (string) - The role of the user.
- **metaData** (object) - The metadata associated with the user.

#### Response Example
```json
{
  "userId": "generated_user_id",
  "emailId": "user@example.com",
  "teamId": "your_team_id",
  "userRole": "Admin",
  "metaData": {
    "department": "Sales",
    "employeeId": null
  }
}
```
```

--------------------------------

### Get Document Properties

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/DocumentApi.md

Retrieves a summary of a specific document using its ID.

```APIDOC
## GET /documents/{documentId}/properties

### Description
Get summary of the document.

### Method
GET

### Endpoint
/documents/{documentId}/properties

### Parameters
#### Path Parameters
- **documentId** (string) - Required - The ID of the document to retrieve properties for.

### Request Example
```json
{
  "documentId": "your_document_id"
}
```

### Response
#### Success Response (200)
- **DocumentProperties** (object) - An object containing the properties of the document.

#### Response Example
```json
{
  "example": "DocumentProperties object"
}
```

### Authorization
- X-API-KEY
- Bearer

### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
```

--------------------------------

### GET /report

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/IdentityVerificationApi.md

Retrieve the ID verification report for the specified document signer.

```APIDOC
## GET /report

### Description
Retrieve the ID verification report for the specified document signer.

### Method
GET

### Endpoint
/report

### Parameters
#### Query Parameters
- **documentId** (string) - Required - The document id.
- **verificationDataRequest** (VerificationDataRequest) - Required - The download image request.

### Request Example
```json
{
  "documentId": "string",
  "verificationDataRequest": {
    "example": "VerificationDataRequest object"
  }
}
```

### Response
#### Success Response (200)
- **IdReport** (IdReport) - Description of the ID report.

#### Response Example
```json
{
  "example": "IdReport object"
}
```

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
- **Accept**: `application/json`
```

--------------------------------

### POST /sendUsingTemplate

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TemplateApi.md

Send a document for signature using a pre-defined template. This method allows you to initiate the signing process by providing a template ID and the necessary details for sending.

```APIDOC
## POST /sendUsingTemplate

### Description
Send a document for signature using a Template.

### Method
POST

### Endpoint
/sendUsingTemplate

### Parameters
#### Path Parameters
- **templateId** (string) - Required - The template id.

#### Request Body
- **sendForSignFromTemplateForm** (SendForSignFromTemplateForm) - Optional - The send template details as JSON.

### Request Example
```json
{
  "templateId": "your_template_id",
  "sendForSignFromTemplateForm": {
    "signerEmails": ["signer1@example.com", "signer2@example.com"],
    "ccEmails": ["cc1@example.com"],
    "documentTitle": "Contract Agreement",
    "message": "Please sign this document."
  }
}
```

### Response
#### Success Response (200)
- **DocumentCreated** (DocumentCreated) - Details of the created document.

#### Response Example
```json
{
  "documentId": "your_document_id",
  "status": "Sent"
}
```

### Authorization
- X-API-KEY
- Bearer
```

--------------------------------

### GET /v1/contactGroups/list - List Group Contacts

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/GroupContactsApi.md

Retrieves a list of all group contacts.

```APIDOC
## GET /v1/contactGroups/list

### Description
List Group Contacts.

### Method
GET

### Endpoint
/v1/contactGroups/list

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **pageSize** (integer) - Optional - The number of items per page.
- **search** (string) - Optional - Search term for filtering contacts.

### Response
#### Success Response (200)
- **result** (List<GroupContactListResponse>) - A list of group contacts.

### Authorization
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)

### HTTP request headers
- **Accept**: `application/json`
```

--------------------------------

### HTTP Request Headers

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/TemplateApi.md

This section outlines the 'Content-Type' and 'Accept' headers and their supported values for making requests to the Boldsign API.

```APIDOC
## HTTP Request Headers

### Description

This section details the supported HTTP request headers for interacting with the Boldsign API using the Node SDK. Proper configuration of these headers is crucial for successful API communication, particularly for specifying the format of the request body and the desired response format.

### Headers

#### Content-Type

This header specifies the media type of the resource that is being sent to the server. The Boldsign API supports a wide range of JSON and other media types for the request body.

- **Supported Values**:
  - `application/json;odata.metadata=minimal;odata.streaming=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false`
  - `application/json;odata.metadata=minimal`
  - `application/json;odata.metadata=full;odata.streaming=true`
  - `application/json;odata.metadata=full;odata.streaming=false`
  - `application/json;odata.metadata=full`
  - `application/json;odata.metadata=none;odata.streaming=true`
  - `application/json;odata.metadata=none;odata.streaming=false`
  - `application/json;odata.metadata=none`
  - `application/json;odata.streaming=true`
  - `application/json;odata.streaming=false`
  - `application/json`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=true`
  - `application/json;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;IEEE754Compatible=false`
  - `application/json;IEEE754Compatible=true`
  - `application/xml`
  - `text/plain`
  - `application/json-patch+json`
  - `text/json`
  - `application/*+json`

#### Accept

This header specifies the media type(s) that are acceptable for the response. The Boldsign API supports various JSON formats and other types for the response.

- **Supported Values**:
  - `application/json;odata.metadata=minimal;odata.streaming=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false`
  - `application/json;odata.metadata=minimal`
  - `application/json;odata.metadata=full;odata.streaming=true`
  - `application/json;odata.metadata=full;odata.streaming=false`
  - `application/json;odata.metadata=full`
  - `application/json;odata.metadata=none;odata.streaming=true`
  - `application/json;odata.metadata=none;odata.streaming=false`
  - `application/json;odata.metadata=none`
  - `application/json;odata.streaming=true`
  - `application/json;odata.streaming=false`
  - `application/json`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=false`
  - `application/json;odata.metadata=minimal;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=full;IEEE754Compatible=false`
  - `application/json;odata.metadata=full;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=false`
  - `application/json;odata.metadata=none;IEEE754Compatible=true`
  - `application/json;odata.streaming=true;IEEE754Compatible=false`
  - `application/json;odata.streaming=true;IEEE754Compatible=true`
  - `application/json;odata.streaming=false;IEEE754Compatible=false`
  - `application/json;odata.streaming=false;IEEE754Compatible=true`
  - `application/json;IEEE754Compatible=false`
  - `application/json;IEEE754Compatible=true`
  - `application/xml`
  - `text/plain`
  - `application/octet-stream`
  - `text/json`
```

--------------------------------

### GET /v1/customField/list

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/CustomFieldApi.md

Lists all custom fields associated with a specific brand ID.

```APIDOC
## GET /v1/customField/list

### Description
List the custom fields respective to the brand id.

### Method
GET

### Endpoint
/v1/customField/list

### Parameters
#### Query Parameters
- **brandId** (string) - Required - The ID of the brand to list custom fields for.

### Response
#### Success Response (200)
- **customFields** (array) - A list of custom field objects.
  - **customFieldId** (string) - The ID of the custom field.
  - **fieldName** (string) - The name of the custom field.
  - **fieldType** (string) - The type of the custom field.
  - **isRequired** (boolean) - Indicates if the custom field is required.
  - **defaultValue** (string) - The default value of the custom field.

#### Response Example
```json
{
  "customFields": [
    {
      "customFieldId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "fieldName": "Project Name",
      "fieldType": "Text",
      "isRequired": true,
      "defaultValue": ""
    },
    {
      "customFieldId": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
      "fieldName": "Department",
      "fieldType": "Dropdown",
      "isRequired": false,
      "defaultValue": "Sales"
    }
  ]
}
```

### Authorization
- X-API-KEY
- Bearer
```

--------------------------------

### GET /documents/team

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/DocumentApi.md

Retrieves a list of team documents with various filtering and pagination options.

```APIDOC
## GET /documents/team

### Description
Retrieves a list of team documents with various filtering and pagination options.

### Method
GET

### Endpoint
/documents/team

### Parameters
#### Query Parameters
- **page** (number) - Optional - Page index specified in get document list request. [default to 1]
- **userId** (Array<string>) - Optional - UserId of the Team document.
- **teamId** (Array<string>) - Optional - TeamId of the Team document.
- **transmitType** ('Sent' | 'Received' | 'Both') - Optional - Transmit type as Sent, Received and Both.
- **dateFilterType** ('SentBetween' | 'Expiring') - Optional - Date Filter as SentBetween and Expiring.
- **pageSize** (number) - Optional - Page size specified in get document list request. [optional] [default to 10]
- **startDate** (Date) - Optional - Start date of the document
- **status** (Array<'None' | 'WaitingForMe' | 'WaitingForOthers' | 'NeedAttention' | 'Completed' | 'Declined' | 'Revoked' | 'Expired' | 'Draft' | 'Scheduled'>) - Optional - Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.
- **endDate** (Date) - Optional - End date of the document
- **searchKey** (string) - Optional - Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,
- **labels** (Array<string>) - Optional - Labels of the document.
- **nextCursor** (number) - Optional - Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
- **brandIds** (Array<string>) - Optional - BrandId(s) of the document.

### Response
#### Success Response (200)
- **TeamDocumentRecords** (object) - Details about the team documents retrieved.

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### GET /sender-identities/{id}

Source: https://github.com/boldsign/boldsign-node-sdk/blob/main/docs/SenderIdentitiesApi.md

Retrieves a specific sender identity by its ID or email address.

```APIDOC
## GET /sender-identities/{id} or GET /sender-identities?email={email}

### Description
Gets sender identity by ID or email.

### Method
GET

### Endpoint
/sender-identities/{id}

### Query Parameters
- **email** (string) - Optional - The sender identity email.

### Path Parameters
- **id** (string) - Optional - The sender identity id.

### Response
#### Success Response (200)
- **SenderIdentityViewModel** (object) - Details of the requested sender identity.

### Response Example
```json
{
  "id": "string",
  "email": "string",
  "name": "string",
  "status": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "brandId": "string"
}
```
```