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 Workflow Session API

Instance of a workflow created each time a customer goes through it.

YouSign Workflow Session 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 Workflow Session. 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 4 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.

5 operations 4 paths 21 schemas 3 GET2 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 Workflow Session 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 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow Session 5

Instance of a workflow created each time a customer goes through it.

GET
/workflow_sessions
List Workflow Sessions
get-workflow_sessions → 200400401403405429500
POST
/workflow_sessions
Create a new Workflow Session
post-workflow_sessions body → 201400401403404405429500
GET
/workflow_sessions/{workflowSessionId}
Get a Workflow Session
get-workflow_sessions-id 1 param → 200400401403404405429500
GET
/workflow_sessions/{workflowSessionId}/links
Generate Workflow Session Links
get-workflow_sessions-id-links 1 param → 200400401403404405429500
POST
/workflow_sessions/{workflowSessionId}/resolve_action
Resolve an Action
post-workflow_sessions-id-resolve_action 1 param body → 204400401403404405429500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are WorkflowSessionLinks_applicants_inner (10 properties), WorkflowSession (8 properties), WorkflowSessionActionResource (5 properties), WorkflowSession_action_groups_inner_actions_inner (3 properties). Each schema is shown below with its type and property counts.

WorkflowSessionLinks
object
Portal links for Workflow Session Applicants.
1 property 1 required
ResolveWorkflowSessionAction_resource
object
2 properties 2 required
InternalServerError
object
2 properties 2 required
WorkflowSession
object
8 properties 8 required
TooManyRequestsResponse
object
1 property 1 required
get_workflow_sessions_200_response
object
2 properties
WorkflowSession_action_groups_inner
object
An Action Group.
3 properties 3 required
CreateWorkflowSession
object
3 properties 2 required
MethodNotAllowed
object
1 property 1 required
WorkflowSessionActionResource
object
The resource associated with this Action.
5 properties 5 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
ResolveWorkflowSessionAction
object
2 properties 1 required
UUID
string
The unique identifier for a resource.
WorkflowSession_action_groups_inner_actions_inner_previous_attempts_inner
object
1 property 1 required
WorkflowSession_action_groups_inner_actions_inner_resolution
object
The resource associated with this Action.
2 properties 2 required
WorkflowSessionLinks_applicants_inner
object
10 properties 10 required
Pagination
object
Metadata about the response.
1 property 1 required
WorkflowSession_action_groups_inner_actions_inner
object
An Action.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-workflow-session-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