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

KYC Process of verifying the identity associated with a bank account document.

YouSign Bank Account 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 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 30 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 30 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 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 Verification 3

KYC Process of verifying the identity associated with a bank account document.

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

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are BankAccountMeta (10 properties), InitiateBankAccountWithLegalPerson (7 properties), InitiateBankAccountWithNaturalPerson (7 properties), InitiateBankAccount (6 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
BankAccountStatus
string
Status of the Bank Account Verification.
InitiateBankAccount
object
6 properties 1 required
BankAccountFull
object
TooManyRequestsResponse
object
1 property 1 required
InitiateBankAccountFromApplicant
object
1 property 1 required
InitiateBankAccountWithLegalPerson
object
7 properties 2 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
BankAccountMeta
object
10 properties 9 required
InitiateBankAccountWithNaturalPerson
object
7 properties 2 required
MethodNotAllowed
object
1 property 1 required
NullableBIC
string
Business Identifier Codes (BIC)
NotFoundResponse
object
2 properties 2 required
BIC
string
Business Identifier Codes (BIC)
BankAccountFull_allOf_data_extracted_from_document
object
Data extracted from the provided bank account document
2 properties 2 required
WorkflowSessionApplicantId
string
Unique identifier of an Applicant.
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.
BankAccountFull_allOf_data
object
1 property 1 required
post_verifications_bank_accounts_request
object
get_verifications_bank_accounts_200_response
object
2 properties
InitiateBankAccountWithNaturalPerson_natural_person
object
The field can not be submitted if field "legalperson" is provided.
2 properties
IBAN
string
International Bank Account Number (IBAN)
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.
InitiateBankAccountWithLegalPerson_legal_person
object
The field can not be submitted if field "naturalperson" is provided.
1 property
NullableIBAN
string
International Bank Account Number (IBAN)
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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