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 Document Verification API

KYC Process of verifying the identity associated with an identity document.

YouSign Identity Document 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 Document 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 24 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 24 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 Document 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 Document Verification 3

KYC Process of verifying the identity associated with an identity document.

GET
/verifications/identity_documents
List Identity Document Verifications
get-verifications-identity_documents 4 params → 200400401403405429500
POST
/verifications/identity_documents
Initiate a new Identity Document Verification
post-verifications-identity_documents body → 201400401403405415429500
GET
/verifications/identity_documents/{identityDocumentVerificationId}
Retrieve an Identity Document Verification
get-verifications-identity_documents-id 1 param → 200400401403404405429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are IdentityDocumentFull_allOf_data_extracted_from_document (14 properties), InitiateIdentityDocument (11 properties), IdentityDocumentMeta (10 properties), InitiateIdentityDocumentWithoutName (9 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
IdentityDocumentFull
object
TooManyRequestsResponse
object
1 property 1 required
post_verifications_identity_documents_request
object
UnsupportedMediaTypeResponse
object
2 properties 2 required
InitiateIdentityDocumentWithoutName
object
9 properties 1 required
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
InitiateIdentityDocumentFromApplicant
object
1 property 1 required
WorkflowSessionApplicantId
string
Unique identifier of an Applicant.
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
BadRequestResponse
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
IdentityDocumentMeta
object
10 properties 10 required
get_verifications_identity_documents_200_response
object
2 properties
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.
InitiateIdentityDocument
object
11 properties 3 required
IdentityDocumentFull_allOf_data
object
1 property 1 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.
IdentityDocumentFull_allOf_data_extracted_from_document
object
Information extracted from the verified identity document
14 properties 14 required
IdentityDocumentFull_allOf_data_extracted_from_document_mrz
object
Machine Readable Zone content
3 properties 3 required
Pagination
object
Metadata about the response.
1 property 1 required
IdentityDocumentStatus
string
Status of the Identity Document Verification

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-identity-document-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