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 Proof of Address Verification API

KYC Process of verifying a proof of address document.

YouSign Proof of Address 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 Proof of Address 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 Proof of Address 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.

Proof of Address Verification 3

KYC Process of verifying a proof of address document.

GET
/verifications/proofs_of_address
List Proof of Address Verifications
get-verifications-proofs_of_address 4 params → 200400401403405429500
POST
/verifications/proofs_of_address
Initiate a new Proof of Address Verification
post-verifications-proofs_of_address body → 201400401403405415429500
GET
/verifications/proofs_of_address/{proofOfAddressVerificationId}
Retrieve a Proof of Address Verification
get-verifications-proofs_of_address-id 1 param → 200400401403404405429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ProofOfAddressMeta (10 properties), ProofOfAddressFull_allOf_data_extracted_from_document (6 properties), InitiateProofOfAddress (5 properties), ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc_address (4 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc_address
object
If found, the address extracted from the 2D-Doc.
4 properties 4 required
TooManyRequestsResponse
object
1 property 1 required
InitiateProofOfAddressFromApplicant
object
1 property 1 required
ProofOfAddressFull_allOf_data
object
1 property 1 required
ProofOfAddressFull
object
get_verifications_proofs_of_address_200_response
object
2 properties
UnsupportedMediaTypeResponse
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
InitiateProofOfAddress_natural_person_address
object
Provide the holder full address, exactly as it should appear on the proof of address document.
4 properties 3 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
WorkflowSessionApplicantId
string
Unique identifier of an Applicant.
UUID
string
The unique identifier for a resource.
ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc
object
Data extracted from the 2D-Doc if the document has one.
2 properties 2 required
ProofOfAddressMeta
object
10 properties 10 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.
InitiateProofOfAddress_natural_person
object
3 properties
ProofOfAddressFull_allOf_data_extracted_from_document
object
Data extracted from the provided proof of address document
6 properties 5 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
InitiateProofOfAddress
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-proof-of-address-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