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 Bank Account Lookup Verification API

KYC Process of verifying a person’s or company’s banking information via the Sepamail DIAMOND network.

YouSign Bank Account Lookup 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 Bank Account Lookup 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 23 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 23 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 Bank Account Lookup 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.

Bank Account Lookup Verification 3

KYC Process of verifying a person’s or company’s banking information via the Sepamail DIAMOND network.

GET
/verifications/bank_account_lookups
List Bank Account Lookup Verifications
get-verifications-bank_account_lookups 4 params → 200400401403405429500
POST
/verifications/bank_account_lookups
Initiate a new Bank Account Lookup Verification
post-verifications-bank_account_lookups body → 201400401403405415429500
GET
/verifications/bank_account_lookups/{bankAccountLookupVerificationId}
Retrieve a Bank Account Lookup Verification
get-verifications-bank_account_lookups-id 1 param → 200400401403404405429500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are BankAccountLookupFull (11 properties), BankAccountLookupMeta (9 properties), InitiateBankAccountLookupWithNaturalPerson (5 properties), InitiateBankAccountLookupWithNaturalPersonFromFile (5 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
TooManyRequestsResponse
object
1 property 1 required
BankAccountLookupFull
object
11 properties 11 required
BankAccountLookupFull_data_extracted_from_document
object
1 property
UnsupportedMediaTypeResponse
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
InitiateBankAccountLookupWithNaturalPerson
object
5 properties 2 required
NotFoundResponse
object
2 properties 2 required
InitiateBankAccountLookupFromApplicant
object
1 property 1 required
BadRequestResponse
object
2 properties 2 required
WorkflowSessionApplicantId
string
Unique identifier of an Applicant.
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
get_verifications_bank_account_lookups_200_response
object
2 properties
UUID
string
The unique identifier for a resource.
BankAccountLookupFull_data
object
1 property 1 required
InitiateBankAccountLookupWithNaturalPersonFromFile
object
5 properties 2 required
InitiateBankAccountLookupWithNaturalPerson_natural_person
object
Information about the natural person who owns the bank account
2 properties 2 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.
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
BankAccountLookupMeta
object
9 properties 9 required
post_verifications_bank_account_lookups_request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-bank-account-lookup-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 Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API
YouSign Document Analysis API