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 Archive API

A feature allowing to store and retrieve documents on Arkhineo for some customers migrated from v2

YouSign Archive 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 Archive. 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 2 operations across 2 paths, 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.

2 operations 2 paths 11 schemas 1 GET1 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
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 2

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

Archive 2

A feature allowing to store and retrieve documents on Arkhineo for some customers migrated from v2

POST
/archives
Direct upload an archived file
post-archives body → 201400401403404405415429
GET
/archives/{archivedFileId}/download
Download archived file
get-archives-archivedFileId-download 1 param → 200400401403404405429500

Schemas 11

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

InternalServerError
object
2 properties 2 required
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
ArchivedFile
object
ArchivedFile
10 properties 10 required
UUID
string
The unique identifier for a resource.
UploadArchivedFile
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-archive-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant API
YouSign Approver 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
YouSign Document Analysis API