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 Identity Video Verification API

KYC Process of verifying the identity associated with a document.

YouSign Identity Video Verification 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 Identity Video Verification. 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 3 operations across 2 paths, and defines 20 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.

3 operations 2 paths 20 schemas 2 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 Identity Video Verification API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

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

Identity Video Verification 3

KYC Process of verifying the identity associated with a document.

GET
/verifications/identity_videos
List Identity Video Verifications
get-verifications-identity_videos 6 params → 200400401403405429500
POST
/verifications/identity_videos
Initiate a new Identity Video Verification
post-verifications-identity_videos body → 201400401403404405429500
GET
/verifications/identity_videos/{identityVideoVerificationId}
Retrieve an Identity Video Verification
get-verifications-identity_videos-id 1 param → 200400401403404405429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are InitiateIdentityVideo (15 properties), IdentityVideoMeta (10 properties), IdentityVideoDocument (5 properties), IdentityVideoFull_allOf_data_evidence (3 properties). Each schema is shown below with its type and property counts.

IdentityVideoFull_allOf_data_evidence
object
Documentary evidence captured during the verification process
3 properties 3 required
HumanName
string
InternalServerError
object
2 properties 2 required
IdentityVideoMeta
object
10 properties 10 required
IdentityVideoDocument
object
Includes all information that has been extracted from the document, as well as the best images of the document.
5 properties 5 required
TooManyRequestsResponse
object
1 property 1 required
IdentityVideoStatus
string
Status of the Identity Video Verification
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
IdentityVideoFull_allOf_data
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
get_verifications_identity_videos_200_response
object
2 properties
IdentityVideoFull
object
PreviousAttemptId
string
ID of the previous attempt within the same workflowsessionid. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.
InitiateIdentityVideo
object
15 properties 3 required
WorkflowSessionId
string
Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.
Pagination
object
Metadata about the response.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-identity-video-verification-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