How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
YouSign

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.2.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.2.0
API Version
3.0
Base URL
https://api.yousign.com/v3
Authentication
HTTP Bearer
Contact
Support
License
proprietary
Resource Areas
1

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 FieldSignatureDate (18 properties), FieldText (18 properties), Text (15 properties), Text_1 (14 properties). Each schema is shown below with its type and property counts.

UpdateField
object
RadioGroup_radios_inner
object
5 properties 2 required
ReadOnlyText_1
object
7 properties
get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner
SignatureDisplay_oneOf
object
1 property 1 required
MethodNotAllowed
object
1 property 1 required
Signature_1
object
8 properties
Pagination
object
Metadata about the response.
1 property 1 required
Checkbox_1
object
9 properties
RadioGroup
object
7 properties 4 required
SignatureDate
object
13 properties 5 required
FontVariants
object
2 properties 2 required
FieldCheckbox
object
11 properties 10 required
FieldSignerEmail
object
12 properties 11 required
RadioGroup_1
object
6 properties
UUID
string
The unique identifier for a resource.
SignatureDisplay_oneOf_1_options
object
Only applicable when display.layout = detailed.
4 properties
CreateSignatureDateFieldFont
objectnull
Font configuration (family, size, color, style variants).
4 properties 4 required
get_signature_requests_signatureRequestId_documents_documentId_fields_200_response
object
2 properties
FieldRadioButtonGroup
object
8 properties 8 required
FieldAnswer
object
1 property 1 required
ForbiddenResponse
object
2 properties 2 required
SignatureDisplay_1
objectnull
Controls what is shown within the signature field.
Text_1
object
14 properties
SignerEmail
object
7 properties 5 required
NotFoundResponse
object
2 properties 2 required
ReadOnlyText
object
8 properties 5 required
FieldSignerName
object
13 properties 11 required
Text
object
15 properties 7 required
CreateFieldDateFormat
string
Format used to display the date (e.g., dd/MM/yyyy, MM/dd/yyyy)
CreateFieldOffsetUnit
stringnull
Unit of time used to offset the signature date. When null, the field will display the exact signature date.
FieldReadOnlyText
object
10 properties 10 required
CreateFieldTimeFormat
stringnull
Format used to display the time. Can be null to display only the date, or a format like HH:mm or hh:mm a
TooManyRequestsResponse
object
1 property 1 required
Detailed_layout
object
2 properties 2 required
Font
object
4 properties 4 required
FieldMention
object
12 properties 11 required
UpdateFieldFont
objectnull
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_1
object
9 properties
FieldRadioButtonGroup_radios_inner
object
5 properties 5 required
CreateFieldNameFormat
string
Format used to display the signer's name.
FieldSignatureDate
object
18 properties 11 required
Checkbox
object
10 properties 5 required
SignerName
object
8 properties 5 required
FieldText
object
18 properties 15 required
SignatureDate_1
object
12 properties
SignatureDisplay
object
Controls what is shown within the signature field.
FieldAnswer_value
RadioGroup_1_radios_inner
object
4 properties 2 required
Mention
object
10 properties 6 required
InternalServerError
object
2 properties 2 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
Minimal_layout
object
1 property 1 required
FieldSignature
object
11 properties 11 required
CreateFieldFont
objectnull
If set, width and height properties become required. Otherwise, if not set or null, the default font will be used.
4 properties 4 required
CreateField
object
UnauthorizedResponse
object
2 properties 2 required
SignatureDisplay_oneOf_1
object
2 properties 2 required
Signature
object
9 properties 5 required
BadRequestResponse
object
2 properties 2 required
HumanName
string
FontFamily
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-field-api-openapi.yml Raw ↑

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
API Details
ID
yousign:yousign-field-api
Base URL
https://api.yousign.com/v3
Docs
https://developers.yousign.com/
Provider
YouSign
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yousign-field-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yousign-field-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of YouSign Field API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.