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

This resource provides tracking of the API usage.

YouSign Consumption 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 Consumption. 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 7 operations across 7 paths, and defines 28 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.

7 operations 7 paths 28 schemas 7 GET

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 Consumption API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

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

Consumption 7

This resource provides tracking of the API usage.

GET
/consumptionsdeprecated
Get Consumptions
get-consumptions 3 params → 200400401403404405429500
GET
/consumptions/addons
Get detailed addon consumption.
get-consumption-addon 1 param → 200400401403404405429500
GET
/consumptions/detail
Get detailed Consumption data
get-consumption-detail 6 params → 200400401403405429500
GET
/consumptions/export
Export Consumption data
get-consumptions-export 3 params → 200400401403404405429500
GET
/consumptions/records/electronic_seals
Get Electronic Seals consumption records
get-consumptions-records-electronic_seals 3 params → 200400401403404405429500
GET
/consumptions/records/identifications
Get Identifications consumption records
get-consumptions-records-identifications 3 params → 200400401403404405429500
GET
/consumptions/records/invited_signers
Get Invited signers consumption records
get-consumptions-records-invited_signers 3 params → 200400401403404405429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are IdentificationsConsumption (19 properties), InvitedSignersConsumption (17 properties), ElectronicSealsConsumption (11 properties), DetailedConsumption (7 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
KycAddonConsumptionsName
string
get_consumptions_records_invited_signers_200_response
object
2 properties 2 required
Consumption
object
3 properties 3 required
TooManyRequestsResponse
object
1 property 1 required
PaginationWithUpdatedAt
object
Cursor based pagination
2 properties 2 required
Consumption_app
object
4 properties 4 required
Consumption_app_qualified_electronic_signature_identification_mode
object
2 properties 2 required
IdentificationsConsumption
object
19 properties 19 required
AddonConsumptionsName
string
Consumption_app_qualified_electronic_signature_identification_mode_identity_verification
object
2 properties 2 required
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
UUID
string
The unique identifier for a resource.
AddonConsumption
object
6 properties 5 required
get_consumption_detail_200_response
object
2 properties
get_consumptions_records_electronic_seals_200_response
object
2 properties 2 required
ElectronicSealsConsumption
object
11 properties 11 required
get_consumptions_records_identifications_200_response
object
2 properties 2 required
DetailedConsumption
object
7 properties 3 required
Consumption_api
object
6 properties 4 required
get_consumption_addon_200_response
object
1 property 1 required
InvitedSignersConsumption
object
17 properties 17 required
Pagination
object
Metadata about the response.
1 property 1 required
DateYMD
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-consumption-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 Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API
YouSign Document Analysis API