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

Check if individuals appear on international sanctions lists or as politically exposed persons (PEPs).

YouSign Watchlist 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 Watchlist 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 25 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 25 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 Watchlist 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.

Watchlist Verification 3

Check if individuals appear on international sanctions lists or as politically exposed persons (PEPs).

GET
/verifications/watchlists
List Watchlist Verifications
get-verifications-watchlists 4 params → 200400401403405429500
POST
/verifications/watchlists
Initiate a new Watchlist Verification
post-verifications-watchlists body → 201400401403405415429500
GET
/verifications/watchlists/{watchlistVerificationId}
Retrieve a Watchlist Verification
get-verifications-watchlists-id 1 param → 200400401403404405429500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are WatchlistMeta (8 properties), WatchlistFull_allOf_data_sanctions_records (7 properties), WatchlistFull_allOf_data_politically_exposed_person_positions (6 properties), InitiateWatchlist (4 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
WatchlistFull_allOf_data
object
Verification result data
2 properties 2 required
TooManyRequestsResponse
object
1 property 1 required
WatchlistFull_allOf_data_politically_exposed_person_sources
object
2 properties 2 required
WatchlistMeta
object
8 properties 8 required
WatchlistFull_allOf_data_politically_exposed_person
object
Information about politically exposed person status
2 properties 2 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
WatchlistFull_allOf_data_sanctions
object
List of sanctions against the person
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
InitiateWatchlist_natural_person
object
Information about the person to check
3 properties 3 required
NotFoundResponse
object
2 properties 2 required
WatchlistFull_allOf_data_sanctions_records
object
7 properties 7 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
WatchlistFull
object
UUID
string
The unique identifier for a resource.
WatchlistStatus
string
Status of the Watchlist Verification.
WatchlistFull_allOf_data_politically_exposed_person_positions
object
6 properties 6 required
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.
InitiateWatchlist
object
4 properties 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.
Pagination
object
Metadata about the response.
1 property 1 required
WatchlistFull_allOf_data_sanctions_sources
object
2 properties 2 required
get_verifications_watchlists_200_response
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-watchlist-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