YouSign Field API

Dynamic content that will appear on a Document.

Documentation Provider Profile APIs.io OpenAPI GitHub

YouSign Field API is one of 38 APIs that YouSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Field. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, rate-limit docs, and 1 JSON Schema.

This API exposes 5 operations across 3 paths, and defines 62 schemas. It is described by OpenAPI 3.0.0, at version 3.0.

Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.

5 operations 3 paths 62 schemas 1 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

3.0

Base URL

https://api.yousign.com/v3

Authentication

HTTP Bearer

Contact

Support

License

proprietary

Resource Areas

Authentication & Security 1

YouSign Field API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Field 5

Dynamic content that will appear on a Document.

GET

/signature_requests/{signatureRequestId}/documents/{documentId}/fields

Lists the Fields of a Signature Request Document.

get-signature_requests-signatureRequestId-documents-documentId-fields 7 params → 200400401403404405429500

POST

/signature_requests/{signatureRequestId}/documents/{documentId}/fields

Create a new Field on a Document

post-signature_requests-signatureRequestId-documents-documentId-fields 2 params body → 201400401403404405415429

DELETE

/signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId}

Delete a Field

delete-signature_requests-signatureRequestId-documents-documentId-fields-fieldId 3 params → 204400401403404405429500

PATCH

/signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId}

Update a Field

update-signature_requests-signatureRequestId-documents-documentId-fields-fieldId 3 params body → 200400401403404405415429

POST

/signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId}/answer

Answer a Field

signature_requests-id-documents-id-fields-id-answer 3 params body → 204400401403404405429500

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are FieldText (18 properties), FieldSignatureDate (18 properties), Text (15 properties), Text_1 (14 properties). Each schema is shown below with its type and property counts.

UpdateField

object

HumanName

string

InternalServerError

object

2 properties 2 required

Text_1

object

14 properties

CreateFieldNameFormat

string

Format used to display the signer's name.

SignerName

object

8 properties 5 required

FieldRadioButtonGroup

object

8 properties 8 required

FieldSignerEmail

object

12 properties 11 required

FieldCheckbox

object

11 properties 10 required

TooManyRequestsResponse

object

1 property 1 required

RadioGroup_1

object

6 properties

CreateFieldFont

object

If set, width and height properties become required. Otherwise, if not set or null, the default font will be used.

4 properties 4 required

Signature

object

9 properties 5 required

Mention_1

object

9 properties

FieldReadOnlyText

object

10 properties 10 required

RadioGroup_radios_inner

object

5 properties 2 required

UpdateFieldFont

object

If set, width and height properties become required. Otherwise, if not set the font will not be changed, and if set to null the default font will be used.

4 properties 4 required

Mention

object

10 properties 6 required

Checkbox_1

object

9 properties

UnsupportedMediaTypeResponse

object

2 properties 2 required

FieldMention

object

12 properties 11 required

FieldSignature

object

11 properties 11 required

SignerEmail

object

7 properties 5 required

ReadOnlyText

object

8 properties 5 required

MethodNotAllowed

object

1 property 1 required

NotFoundResponse

object

2 properties 2 required

SignatureDisplay

object

Controls what is shown within the signature field.

Text

object

15 properties 7 required

FieldAnswer

object

1 property 1 required

Minimal_layout

object

1 property 1 required

SignatureDate_1

object

12 properties

Checkbox

object

10 properties 5 required

BadRequestResponse

object

2 properties 2 required

SignatureDisplay_oneOf

object

1 property 1 required

UnauthorizedResponse

object

2 properties 2 required

FieldText

object

18 properties 15 required

ForbiddenResponse

object

2 properties 2 required

ReadOnlyText_1

object

7 properties

Font

object

4 properties 4 required

Detailed_layout

object

2 properties 2 required

CreateField

object

RadioGroup

object

7 properties 4 required

UUID

string

The unique identifier for a resource.

FieldSignerName

object

13 properties 11 required

Signature_1

object

8 properties

RadioGroup_1_radios_inner

object

4 properties 2 required

CreateFieldOffsetUnit

string

Unit of time used to offset the signature date. When null, the field will display the exact signature date.

SignatureDate

object

13 properties 5 required

SignatureDisplay_oneOf_1_options

object

Only applicable when display.layout = detailed.

4 properties

CreateSignatureDateFieldFont

object

Font configuration (family, size, color, style variants).

4 properties 4 required

SignatureDisplay_oneOf_1

object

2 properties 2 required

get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner

FieldSignatureDate

object

18 properties 11 required

FontFamily

string

CreateFieldTimeFormat

string

Format used to display the time. Can be null to display only the date, or a format like HH:mm or hh:mm a

get_signature_requests_signatureRequestId_documents_documentId_fields_200_response

object

2 properties

FontVariants

object

2 properties 2 required

FieldAnswer_value

Pagination

object

Metadata about the response.

1 property 1 required

FieldRadioButtonGroup_radios_inner

object

5 properties 5 required

CreateFieldDateFormat

string

Format used to display the date (e.g., dd/MM/yyyy, MM/dd/yyyy)

SignatureDisplay_1

object

Controls what is shown within the signature field.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs YouSign publishes across the network.

YouSign Applicant API

AE Profile APIs.io

YouSign Approver API

AE Profile APIs.io

YouSign Archive API

AE Profile APIs.io

YouSign Audit Trail API

AE Profile APIs.io

YouSign Bank Account Lookup Verification API

AE Profile APIs.io

YouSign Bank Account Verification API

AE Profile APIs.io

YouSign Company Verification API

AE Profile APIs.io

YouSign Consumption API

AE Profile APIs.io

YouSign Contact API

AE Profile APIs.io

YouSign Custom Experience API

AE Profile APIs.io

YouSign Custom Property API

AE Profile APIs.io

YouSign Deprecated API

AE Profile APIs.io

#Field

← Back to Y APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

YouSign Field API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 62

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

YouSign Field API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 62

Specification

Source

More from YouSign 12

API Details

Provider

Explore more