Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouSign Metadata API

Extra information attached to a Signature Request.

YouSign Metadata 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 Metadata. 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 4 operations across 1 path, and defines 11 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.

4 operations 1 paths 11 schemas 1 DELETE1 GET1 POST1 PUT

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
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Metadata 4

Extra information attached to a Signature Request.

DELETE
/signature_requests/{signatureRequestId}/metadata
Delete the Signature Request Metadata
delete-signature_requests-signatureRequestId-metadata 1 param → 204401403404405429500
GET
/signature_requests/{signatureRequestId}/metadata
Get the Signature Request Metadata
get-signature_requests-signatureRequestId-metadata 1 param → 200401403404405429500
POST
/signature_requests/{signatureRequestId}/metadata
Attach Metadata to a Signature Request
post-signature_requests-signatureRequestId-metadata 1 param body → 201400401403404405415429
PUT
/signature_requests/{signatureRequestId}/metadata
Update Metadata of a Signature Request
put-signature_requests-signatureRequestId-metadata 1 param body → 200400401403404405429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ForbiddenResponse (2 properties), BadRequestResponse (2 properties), InternalServerError (2 properties), UnsupportedMediaTypeResponse (2 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
Metadata
object
Metadata allows you to attach extra information to your Signature Requests.\ This field must contain JSON data (key / value), with 10 nodes maximum.\ Each node…
1 property
TooManyRequestsResponse
object
1 property 1 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
Metadata_data_value

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-metadata-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant API
YouSign Approver API
YouSign Archive API
YouSign Audit Trail API
YouSign Bank Account Lookup Verification API
YouSign Bank Account Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API