Applicant4

Approver6

Archive2

Audit Trail3

Bank Account Lookup Verification3

Bank Account Verification3

Company Verification3

Consumption7

Contact5

Custom Experience7

Custom Property5

Deprecated1

Document8

Document Trust Analysis3

Electronic Seal3

Electronic Seal Audit Trail2

Electronic Seal Document3

Electronic Seal Image4

Field5

Follower2

Identity Document Verification3

Identity Video Verification3

Label8

Metadata4

Ongoing Monitoring - Natural person3

Proof of Address Verification3

Signature and Seal Verification3

Signature Request12

Signer11

Signer Consent Request6

Signer Document Request9

Template2

User7

User Invitation3

Verification Audit Trail1

Watchlist Verification3

Webhook5

Workflow Session5

Workflow Template1

Workspace7

Signer

Create a new Signer

Changed on Nov 3, 2026

Adds a Signer to a given Signature Request.

post/signature_requests/{signatureRequestId}/signers

Request

Base URL
https://api-sandbox.yousign.app/v3
Auth
HTTP bearer
TypeScript
https://skmtc.dev/yousign/apis/yousign/docs/signature_requests/:signatureRequestId/signers/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

Request body

Example request

{
  "info": {
    "phone_number": "+41446667700"
  },
  "fields": [
    {
      "document_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748"
    }
  ],
  "insert_after_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "group_with_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "redirect_urls": {
    "success": "https://example.com/success",
    "error": "https://example.com/error",
    "decline": "https://example.com/decline"
  },
  "excluded_documents": [
    "89120884-d29a-4b1a-ac7b-a9e73a872796",
    "7c0c2d1e-3f4a-5b6c-8d9e-0f1a2b3c4d5e"
  ],
  "disabled_signing_contexts": [
    "inbox",
    "signature_portal"
  ]
}

Response

Created

idstring uuid required

signature_level'electronic_signature' | 'advanced_electronic_signature' | 'qualified_electronic_signature' required

signature_authentication_mode'null' | 'otp_email' | 'otp_sms' | 'no_otp' nullable required

Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.

signature_linkstring uri nullable required

signature_link_expiration_datestring date-time nullable required

signature_image_previewstring nullable required

delivery_mode'email' | 'none' nullable required

identification_attestation_idstring nullable required

pre_identity_verification_requiredboolean required

verified_identity_idstring uuid nullable required

recipient_stage_indexinteger required

Position of the recipient in the signing flow. Recipients with the same index are notified simultaneously.

excluded_documentsstring[] required

List of Document IDs not visible to this Signer.

disabled_signing_contextsstring[] required

Allows you to make Signature Requests unavailable in the contexts specified in this setting.

signed_atstring date-time nullable required

Timestamp indicating when the Signer completed their signature. Returns null otherwise.

Example response

{
  "fields": [
    {
      "id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
      "document_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
      "signer_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
      "display": {
        "options": {
          "date_format": "dd/MM/yyyy",
          "time_format": "HH:mm"
        }
      }
    }
  ],
  "signature_link_expiration_date": "2024-01-18T22:59:00Z",
  "redirect_urls": {
    "success": "https://example.com/success",
    "error": "https://example.com/error",
    "decline": "https://example.com/decline"
  },
  "disabled_signing_contexts": [
    "inbox",
    "signature_portal"
  ],
  "signed_at": "2024-01-18T22:59:00Z"
}

Changes

Nov 3, 2026d70860094a83 Revision changes
- breaking
  the // request property type changed from no type to string
- breaking
  the // request property type changed from no type to string
- breaking
  the response's body type changed from no type to object for status
- info
  the // request property's minLength was decreased from 2 to 1
- info
  the // request property's minLength was decreased from 2 to 1
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history