# Yousign

> Prepare signature requests, manage signers and contacts, and download signed documents.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/yousign

## Actions

### Activate signature request

Activate signature request in Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Sender ID (`sender_id`, text): The Id of the User that should be considered as the Signature Request sender.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "activated_at": "example",
    "approved_at": "example",
    "approvers": [],
    "audit_trail_locale": "de",
    "branding_id": "example",
    "completed_at": "example",
    "created_at": "example",
    "custom_experience_id": "example",
    "custom_recipient_order": false,
    "delivery_mode": "email",
    "documents": [],
    "email_custom_note": "example",
    "expiration_date": "example",
    "external_id": "example",
    "id": "example",
    "labels": [],
    "name": "example",
    "ordered_approvers": false,
    "ordered_signers": false,
    "previous_attempt_id": "example",
    "rejection_information": {
      "approver_id": "example",
      "reason": "example",
      "rejected_at": "example"
    },
    "reminder_settings": {
      "interval_in_days": 1,
      "max_occurrences": 1
    },
    "signers": [],
    "signers_allowed_to_decline": false,
    "smart_anchors_resolution": "on_activation",
    "status": "ongoing",
    "timezone": "example",
    "workflow_session_id": "example"
  }
}
```

### Add signer

Add signer in Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Fields (`fields`, list): Fields to assign to the Signer. Multiple Fields can be added simultaneously.
- Signature level (`signature_level`, text, required): Signature level. One of: `electronic_signature` (Electronic signature), `advanced_electronic_signature` (Advanced electronic signature), `qualified_electronic_signature` (Qualified electronic signature).
- Signature authentication mode (`signature_authentication_mode`, text): Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China. One of: `otp_email` (Otp email), `otp_sms` (Otp sms), `no_otp` (No otp).
- First name (`first_name`, text, required): First name.
- Last name (`last_name`, text, required): Last name.
- Email (`email`, text, required): Email.
- Phone number (`phone_number`, text): E.164 format. Becomes mandatory if `signature_authentication_mode` requires a phone number.
- Locale (`locale`, text, required): Locale settings used for communication. One of: `en`, `fr`, `de`, `it`, `nl`, `es`, `pl`, `pt`, `ro`.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "custom_text": {
      "reminder_body": "example",
      "reminder_subject": "example",
      "request_body": "example",
      "request_subject": "example"
    },
    "delivery_mode": "email",
    "disabled_signing_contexts": [],
    "email_notification": {
      "disabled": []
    },
    "excluded_documents": [],
    "fields": [],
    "id": "example",
    "identification_attestation_id": "example",
    "identity_pool": [],
    "info": {
      "email": "example",
      "first_name": "example",
      "last_name": "example",
      "locale": "en",
      "phone_number": "example"
    },
    "pre_identity_verification_required": false,
    "recipient_stage_index": 1,
    "redirect_urls": {
      "decline": "example",
      "error": "example",
      "success": "example"
    },
    "signature_authentication_mode": "otp_email",
    "signature_image_preview": "example",
    "signature_level": "electronic_signature",
    "signature_link": "example",
    "signature_link_expiration_date": "example",
    "signed_at": "example",
    "smart_anchor_identifier": "example",
    "sms_notification": {
      "otp_message": {
        "custom_text": "example"
      }
    },
    "status": "initiated",
    "verified_identity_id": "example"
  }
}
```

### Cancel signature request

Cancel signature request in Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Reason (`reason`, text, required): Reason for cancelling the Signature Request. One of: `contractualization_aborted` (Contractualization aborted), `errors_in_document` (Errors in document), `other`.
- Custom note (`custom_note`, text): Free-text note detailing the cancellation reason.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "activated_at": "example",
    "approved_at": "example",
    "approvers": [],
    "audit_trail_locale": "de",
    "branding_id": "example",
    "bulk_send_batch_id": "example",
    "completed_at": "example",
    "created_at": "example",
    "custom_experience_id": "example",
    "custom_properties": [],
    "custom_recipient_order": false,
    "decline_information": {
      "declined_at": "example",
      "reason": "example",
      "signer_id": "example"
    },
    "delivery_mode": "email",
    "documents": [],
    "email_custom_note": "example",
    "email_notification": {
      "custom_note": "example",
      "custom_text": {
        "reminder_body": "example",
        "reminder_subject": "example",
        "request_body": "example",
        "request_subject": "example"
      },
      "sender": {
        "custom_name": "example",
        "type": "organization"
      }
    },
    "embedded_preparation": {
      "redirect_urls": {
        "back": "example",
        "done": "example"
      }
    },
    "expiration_date": "example",
    "external_id": "example",
    "id": "example",
    "labels": [],
    "name": "example",
    "ordered_approvers": false,
    "ordered_signers": false,
    "previous_attempt_id": "example",
    "rejection_information": {
      "approver_id": "example",
      "reason": "example",
      "rejected_at": "example"
    },
    "reminder_settings": {
      "interval_in_days": 1,
      "max_occurrences": 1
    },
    "sender": {
      "email": "example",
      "id": "example"
    },
    "signers": [],
    "signers_allowed_to_decline": false,
    "smart_anchors_resolution": "on_activation",
    "source": "app",
    "status": "draft",
    "timezone": "example",
    "workflow_session_id": "example",
    "workspace_id": "example"
  }
}
```

### Create contact

Create contact in Yousign.

**Inputs**

- First name (`first_name`, text, required): First name.
- Last name (`last_name`, text, required): Last name.
- Email (`email`, text, required): Email.
- Locale (`locale`, text, required): Locale settings used for communication. One of: `en`, `fr`, `de`, `it`, `nl`, `es`, `pl`, `pt`, `ro`.
- Phone number (`phone_number`, text): E.164 format.
- Company name (`company_name`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Job title (`job_title`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Address line 1 (`address_line_1`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Address line 2 (`address_line_2`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Address city (`address_city`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Address postal code (`address_postal_code`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Address country (`address_country`, text): This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).
- Workspace ID (`workspace_id`, text): Workspace id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "address_city": "example",
    "address_country": "example",
    "address_line_1": "example",
    "address_line_2": "example",
    "address_postal_code": "example",
    "company_name": "example",
    "email": "example",
    "first_name": "example",
    "id": "example",
    "job_title": "example",
    "last_name": "example",
    "locale": "example",
    "phone_number": "example",
    "workspace_id": "example"
  }
}
```

### Create signature request

Create signature request in Yousign.

**Inputs**

- Name (`name`, text, required): Name of the signature request.\.
- Delivery mode (`delivery_mode`, text, required): Delivery mode to notify Signers. One of: `none`, `email`.
- Ordered signers (`ordered_signers`, true/false): Enable an ordered workflow, each Signer will be requested to sign in a sequential order.
- Timezone (`timezone`, text): Time zone of the dates and times displayed in emails, the Signature Request expiration date, and the PDF Audit Trail. Format: tz database. Default is set to Europe/Paris.
- Expiration date (`expiration_date`, date): Date the request expires at the end of the day in its time zone.
- External ID (`external_id`, text): Store a custom id that will be added to webhooks & appended to redirect urls.
- Signers allowed to decline (`signers_allowed_to_decline`, true/false): Allowing signers to decline to sign.
- Template (`template_id`, text): Template to use when preparing the request.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "activated_at": "example",
    "approved_at": "example",
    "approvers": [],
    "audit_trail_locale": "de",
    "branding_id": "example",
    "bulk_send_batch_id": "example",
    "completed_at": "example",
    "created_at": "example",
    "custom_experience_id": "example",
    "custom_properties": [],
    "custom_recipient_order": false,
    "decline_information": {
      "declined_at": "example",
      "reason": "example",
      "signer_id": "example"
    },
    "delivery_mode": "email",
    "documents": [],
    "email_custom_note": "example",
    "email_notification": {
      "custom_note": "example",
      "custom_text": {
        "reminder_body": "example",
        "reminder_subject": "example",
        "request_body": "example",
        "request_subject": "example"
      },
      "sender": {
        "custom_name": "example",
        "type": "organization"
      }
    },
    "embedded_preparation": {
      "redirect_urls": {
        "back": "example",
        "done": "example"
      }
    },
    "expiration_date": "example",
    "external_id": "example",
    "id": "example",
    "labels": [],
    "name": "example",
    "ordered_approvers": false,
    "ordered_signers": false,
    "previous_attempt_id": "example",
    "rejection_information": {
      "approver_id": "example",
      "reason": "example",
      "rejected_at": "example"
    },
    "reminder_settings": {
      "interval_in_days": 1,
      "max_occurrences": 1
    },
    "sender": {
      "email": "example",
      "id": "example"
    },
    "signers": [],
    "signers_allowed_to_decline": false,
    "smart_anchors_resolution": "on_activation",
    "source": "app",
    "status": "draft",
    "timezone": "example",
    "workflow_session_id": "example",
    "workspace_id": "example"
  }
}
```

### Delete contact

Delete contact in Yousign.

**Inputs**

- Contact (`contact_id`, text, required): Contact Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {}
}
```

### Delete signature request

Delete signature request in Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {}
}
```

### Download document

Download document in Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Document (`document_id`, text, required): Document Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Get contact

Retrieve contact from Yousign.

**Inputs**

- Contact (`contact_id`, text, required): Contact Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "address_city": "example",
    "address_country": "example",
    "address_line_1": "example",
    "address_line_2": "example",
    "address_postal_code": "example",
    "company_name": "example",
    "email": "example",
    "first_name": "example",
    "id": "example",
    "job_title": "example",
    "last_name": "example",
    "locale": "example",
    "phone_number": "example",
    "workspace_id": "example"
  }
}
```

### Get document

Retrieve document from Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Document (`document_id`, text, required): Document Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "content_type": "example",
    "created_at": "example",
    "excluded_approvers": [],
    "excluded_signers": [],
    "filename": "example",
    "id": "example",
    "initials": {
      "alignment": "left",
      "per_page": [],
      "y": 1
    },
    "is_locked": false,
    "is_protected": false,
    "is_signed": false,
    "nature": "attachment",
    "sha256": "example",
    "total_anchors": 1,
    "total_pages": 1
  }
}
```

### Get signature request

Retrieve signature request from Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "activated_at": "example",
    "approved_at": "example",
    "approvers": [],
    "audit_trail_locale": "de",
    "branding_id": "example",
    "bulk_send_batch_id": "example",
    "completed_at": "example",
    "created_at": "example",
    "custom_experience_id": "example",
    "custom_properties": [],
    "custom_recipient_order": false,
    "decline_information": {
      "declined_at": "example",
      "reason": "example",
      "signer_id": "example"
    },
    "delivery_mode": "email",
    "documents": [],
    "email_custom_note": "example",
    "email_notification": {
      "custom_note": "example",
      "custom_text": {
        "reminder_body": "example",
        "reminder_subject": "example",
        "request_body": "example",
        "request_subject": "example"
      },
      "sender": {
        "custom_name": "example",
        "type": "organization"
      }
    },
    "embedded_preparation": {
      "redirect_urls": {
        "back": "example",
        "done": "example"
      }
    },
    "expiration_date": "example",
    "external_id": "example",
    "id": "example",
    "labels": [],
    "name": "example",
    "ordered_approvers": false,
    "ordered_signers": false,
    "previous_attempt_id": "example",
    "rejection_information": {
      "approver_id": "example",
      "reason": "example",
      "rejected_at": "example"
    },
    "reminder_settings": {
      "interval_in_days": 1,
      "max_occurrences": 1
    },
    "sender": {
      "email": "example",
      "id": "example"
    },
    "signers": [],
    "signers_allowed_to_decline": false,
    "smart_anchors_resolution": "on_activation",
    "source": "app",
    "status": "draft",
    "timezone": "example",
    "workflow_session_id": "example",
    "workspace_id": "example"
  }
}
```

### Get signer

Retrieve signer from Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Signer (`signer_id`, text, required): Signer Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "custom_text": {
      "reminder_body": "example",
      "reminder_subject": "example",
      "request_body": "example",
      "request_subject": "example"
    },
    "delivery_mode": "email",
    "disabled_signing_contexts": [],
    "email_notification": {
      "disabled": []
    },
    "excluded_documents": [],
    "fields": [],
    "id": "example",
    "identification_attestation_id": "example",
    "identity_pool": [],
    "info": {
      "email": "example",
      "first_name": "example",
      "last_name": "example",
      "locale": "en",
      "phone_number": "example"
    },
    "pre_identity_verification_required": false,
    "recipient_stage_index": 1,
    "redirect_urls": {
      "decline": "example",
      "error": "example",
      "success": "example"
    },
    "signature_authentication_mode": "otp_email",
    "signature_image_preview": "example",
    "signature_level": "electronic_signature",
    "signature_link": "example",
    "signature_link_expiration_date": "example",
    "signed_at": "example",
    "smart_anchor_identifier": "example",
    "sms_notification": {
      "otp_message": {
        "custom_text": "example"
      }
    },
    "status": "initiated",
    "verified_identity_id": "example"
  }
}
```

### Get template

Retrieve template from Yousign.

**Inputs**

- Template (`template_id`, text, required): Template Id.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "custom_experience_id": "example",
    "description": "example",
    "email_notification": {
      "custom_note": "example",
      "custom_text": {
        "reminder_body": "example",
        "reminder_subject": "example",
        "request_body": "example",
        "request_subject": "example"
      },
      "sender": {
        "custom_name": "example",
        "type": "organization"
      }
    },
    "expiration_delay": {
      "unit": "days",
      "value": 1
    },
    "id": "example",
    "labels": [],
    "name": "example",
    "placeholders": {
      "documents": [],
      "read_only_text_fields": [],
      "signers": []
    },
    "status": "draft",
    "updated_at": "example",
    "workspace_id": "example"
  }
}
```

### List contacts

Retrieve a page of contacts from Yousign.

**Inputs**

- After (`after`, text): After cursor (pagination).
- Limit (`limit`, number): The limit of items count to retrieve. From 1 to 100.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "next_cursor": "example"
    }
  }
}
```

### List documents

Retrieve a page of documents from Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Nature (`nature`, object): Filter by `nature`. Allowed operators: `eq`.

**Outputs**

- `data` (list): The result returned by Yousign.

**Example output**

```json
{
  "data": []
}
```

### List signature requests

Retrieve a page of signature requests from Yousign.

**Inputs**

- After (`after`, text): Cursor for pagination; pass the `meta.next_cursor` value from the previous response to fetch the next page.
- Limit (`limit`, number): The limit of items count to retrieve. From 1 to 100.
- Q (`q`, text): Free-text search on the Signature Request name.
- Created after (`created_after`, date): Created after this date.
- Created before (`created_before`, date): Created before this date.
- Completed after (`completed_after`, date): Completed after this date.
- Completed before (`completed_before`, date): Completed before this date.
- Statuses (`statuses`, list): Return requests with any of these statuses. One or more of: `draft`, `ongoing`, `done`, `deleted`, `expired`, `canceled`, `approval`, `rejected`, `declined`, `paused`.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "next_cursor": "example"
    }
  }
}
```

### List signers

Retrieve a page of signers from Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.

**Outputs**

- `data` (list): The result returned by Yousign.

**Example output**

```json
{
  "data": []
}
```

### List templates

Retrieve a page of templates from Yousign.

**Inputs**

- After (`after`, text): After cursor (pagination).
- Limit (`limit`, number): The limit of items count to retrieve. From 1 to 10.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "next_cursor": "example"
    }
  }
}
```

### Update signature request

Update signature request in Yousign.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- Name (`name`, text): Name of the Signature Request.
- Delivery mode (`delivery_mode`, text): Delivery mode to notify signers. One of: `none`, `email`.
- Ordered signers (`ordered_signers`, true/false): Enable an ordered workflow, each signer will be requested to sign in a sequential order.
- Timezone (`timezone`, text): Time zone of the dates and times displayed in emails, the Signature Request expiration date, and the PDF Audit Trail. Format: tz database. Default is set to Europe/Paris.
- Expiration date (`expiration_date`, date): Date the request expires at the end of the day in its time zone.
- External ID (`external_id`, text): Custom identifier added to webhooks and appended to redirect URLs.
- Signers allowed to decline (`signers_allowed_to_decline`, true/false): Allowing signers to decline to sign.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "activated_at": "example",
    "approved_at": "example",
    "approvers": [],
    "audit_trail_locale": "de",
    "branding_id": "example",
    "bulk_send_batch_id": "example",
    "completed_at": "example",
    "created_at": "example",
    "custom_experience_id": "example",
    "custom_properties": [],
    "custom_recipient_order": false,
    "decline_information": {
      "declined_at": "example",
      "reason": "example",
      "signer_id": "example"
    },
    "delivery_mode": "email",
    "documents": [],
    "email_custom_note": "example",
    "email_notification": {
      "custom_note": "example",
      "custom_text": {
        "reminder_body": "example",
        "reminder_subject": "example",
        "request_body": "example",
        "request_subject": "example"
      },
      "sender": {
        "custom_name": "example",
        "type": "organization"
      }
    },
    "embedded_preparation": {
      "redirect_urls": {
        "back": "example",
        "done": "example"
      }
    },
    "expiration_date": "example",
    "external_id": "example",
    "id": "example",
    "labels": [],
    "name": "example",
    "ordered_approvers": false,
    "ordered_signers": false,
    "previous_attempt_id": "example",
    "rejection_information": {
      "approver_id": "example",
      "reason": "example",
      "rejected_at": "example"
    },
    "reminder_settings": {
      "interval_in_days": 1,
      "max_occurrences": 1
    },
    "sender": {
      "email": "example",
      "id": "example"
    },
    "signers": [],
    "signers_allowed_to_decline": false,
    "smart_anchors_resolution": "on_activation",
    "source": "app",
    "status": "draft",
    "timezone": "example",
    "workflow_session_id": "example",
    "workspace_id": "example"
  }
}
```

### Upload PDF document

Attach a PDF to a draft signature request as a signable document or attachment.

**Inputs**

- Signature request (`signature_request_id`, text, required): Signature Request Id.
- File base64 (`file_base64`, text, required): PDF bytes encoded as Base64. Use the content from a previous file step.
- Filename (`filename`, text, required): Name to give the uploaded PDF, including .pdf.
- Nature (`nature`, text, required): Choose whether people sign this document. One of: `signable_document` (Signable document), `attachment`.
- Parse anchors (`parse_anchors`, true/false): Find Smart Anchors in the PDF.

**Outputs**

- `data` (object): The result returned by Yousign.

**Example output**

```json
{
  "data": {
    "content_type": "example",
    "created_at": "example",
    "excluded_approvers": [],
    "excluded_signers": [],
    "filename": "example",
    "id": "example",
    "initials": {
      "alignment": "left",
      "per_page": [],
      "y": 1
    },
    "is_locked": false,
    "is_protected": false,
    "is_signed": false,
    "nature": "attachment",
    "sha256": "example",
    "total_anchors": 1,
    "total_pages": 1
  }
}
```
