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 Custom Experience API

Allows to customize the look and feel of the signature experience.

YouSign Custom Experience 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 Custom Experience. 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 7 operations across 3 paths, and defines 21 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.

7 operations 3 paths 21 schemas 2 DELETE2 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
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 7

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

Custom Experience 7

Allows to customize the look and feel of the signature experience.

GET
/custom_experiences
List Custom Experiences
get-custom_experiences 2 params → 200400401403405429500
POST
/custom_experiences
Create a Custom Experience
post-custom-experience body → 201400401403405415429500
DELETE
/custom_experiences/{customExperienceId}
Delete a Custom Experience
delete-custom_experience 1 param → 204400401403404405429500
GET
/custom_experiences/{customExperienceId}
Get a Custom Experience
get-custom_experiences-customExperienceId 1 param → 200400401403404405429500
PATCH
/custom_experiences/{customExperienceId}
Update a Custom Experience
patch-custom_experiences-customExperienceId 1 param body → 200400401403404405415429
DELETE
/custom_experiences/{customExperienceId}/logo
Delete a Custom Experience logo
delete-custom_experience-logo 1 param → 204400401403404405429500
POST
/custom_experiences/{customExperienceId}/logo
Update a Custom Experience logo
patch-custom-experience-logo 1 param body → 201400401403405415429500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are CustomExperience (20 properties), UpdateCustomExperience (17 properties), CreateCustomExperience (17 properties), UpdateCustomExperience_redirect_urls (3 properties). Each schema is shown below with its type and property counts.

CreateCustomExperience_redirect_urls
object
3 properties
InternalServerError
object
2 properties 2 required
CustomExperience
object
20 properties 19 required
patch_custom_experience_logo_request
object
Upload a file
1 property 1 required
TooManyRequestsResponse
object
1 property 1 required
CustomExperience_redirect_urls
object
3 properties 3 required
CreateCustomExperience
object
17 properties 1 required
CustomExperience_DisabledNotificationsType
string
UpdateCustomExperience
object
17 properties
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
LogoLayout
string
Determines the display layout of the logo. Possible values are: - round: Displays the logo in a circular format. - original: Displays the logo in its original…
UUID
string
The unique identifier for a resource.
CustomExperience_Source
string
Custom Experience Source
get_custom_experiences_200_response
object
2 properties
UpdateCustomExperience_redirect_urls
object
3 properties 3 required
Pagination
object
Metadata about the response.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-custom-experience-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 Property API
YouSign Deprecated API
YouSign Document Analysis API