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

A saved profile containing some information (name, language, email address, etc.) that can be re-used to create a Signer, Approver, or Follower.

YouSign Contact 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 Contact. 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 2 paths, and defines 16 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 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 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 Contact 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Contact 5

A saved profile containing some information (name, language, email address, etc.) that can be re-used to create a Signer, Approver, or Follower.

GET
/contacts
List Contacts
get-contacts 2 params → 200400401403405429500
POST
/contacts
Create a Contact
post-contact body → 201400401403404405429500
DELETE
/contacts/{contactId}
Delete a Contact
delete-contacts-contactId 1 param → 204401403404405429500
GET
/contacts/{contactId}
Get a Contact
get-contacts-contactId 1 param → 200401403404405429500
PATCH
/contacts/{contactId}
Update a Contact
patch-contacts-contactId 1 param body → 200400401403404405415429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Contact (14 properties), CreateContact (13 properties), UpdateContact (13 properties), ForbiddenResponse (2 properties). Each schema is shown below with its type and property counts.

get_contacts_200_response
object
2 properties
HumanName
string
InternalServerError
object
2 properties 2 required
TooManyRequestsResponse
object
1 property 1 required
CreateContact
object
13 properties 4 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
Locale
string
Locale settings used for communication.
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.
Contact
object
14 properties 13 required
UpdateContact
object
13 properties
Pagination
object
Metadata about the response.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-contact-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 Custom Experience API
YouSign Custom Property API
YouSign Deprecated API
YouSign Document Analysis API