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

An applicant associated with a Workflow Session.

YouSign Applicant 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 Applicant. 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 2 paths, and defines 27 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 2 paths 27 schemas 2 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 Applicant 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 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Applicant 4

An applicant associated with a Workflow Session.

GET
/workflow_sessions/{workflowSessionId}/applicants
List Applicants
get-workflow_sessions-id-applicants 4 params → 200400401403405429500
POST
/workflow_sessions/{workflowSessionId}/applicants
Create a new Applicant
post-workflow_sessions-id-applicants 1 param body → 201400401403404405429500
GET
/workflow_sessions/{workflowSessionId}/applicants/{applicantId}
Get an Applicant
get-workflow_sessions-id-applicants-id 2 params → 200400401403404405429500
PATCH
/workflow_sessions/{workflowSessionId}/applicants/{applicantId}
Update an Applicant
patch-workflow_sessions-id-applicants-id 2 params body → 200400401403404405429500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Legal_Person_Applicant (9 properties), Natural_Person_Applicant (9 properties), WorkflowSessionApplicantListItem (8 properties), CreateLegalPerson (4 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
LegalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
4 properties 4 required
UpdateWorkflowSessionApplicant
object
Update an Applicant associated with a Workflow Session (PATCH).
4 properties
Legal_Person_Applicant
object
A legal person Applicant.
9 properties 9 required
TooManyRequestsResponse
object
1 property 1 required
WorkflowSessionApplicant
An Applicant associated with a Workflow Session (full view).
CreateLegalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
4 properties
WorkflowSessionApplicantListItem
object
An Applicant associated with a Workflow Session (list view).
8 properties 8 required
CreateWorkflowSessionApplicant
Request body to create a new Applicant for a Workflow Session.
UpdateNaturalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
3 properties
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
Natural_Person_Applicant
object
A natural person Applicant.
9 properties 9 required
NaturalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
3 properties 3 required
UpdateLegalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
4 properties
BadRequestResponse
object
2 properties 2 required
Address
object
Provide the Applicants full address.
4 properties 3 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
CreateWorkflowSessionApplicantLegalPerson
object
Create a legal person Applicant.
4 properties 2 required
UUID
string
The unique identifier for a resource.
CreateNaturalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
3 properties
BankAccount
object
Bank account details.
2 properties 1 required
Pagination
object
Metadata about the response.
1 property 1 required
get_workflow_sessions_id_applicants_200_response
object
2 properties
Identity
object
Describes the Applicant.
2 properties 2 required
CreateWorkflowSessionApplicantNaturalPerson
object
Contains information that describe the applicant. This data is used for cross-validation with the data Yousign extracts from the applicant documents and verifi…
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-applicant-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

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