Ubble Bank document verifications (Coming soon) API
The Bank document verifications (Coming soon) API from Ubble — 8 operation(s) for bank document verifications (coming soon).
OpenAPI Specification
openapi: 3.0.3
info:
title: Checkout.com - Identity Verification Address document verifications (Coming soon) Address document verifications (Coming soon) Bank document verifications (Coming soon) API
version: 1.0.0
x-logo:
url: https://raw.githubusercontent.com/ubbleai/docs/main/cko_doc_logo.png
description: ''
servers:
- url: https://api.ubble.ai
tags:
- name: Bank document verifications (Coming soon)
paths:
/v2/bank-document-verifications:
post:
tags:
- Bank document verifications (Coming soon)
summary: Create a Bank Document Verification
operationId: create_bank_document_verification
description: Creates a Bank Document Verification
requestBody:
required: true
content:
application/json:
examples:
bank_document_verification_creation_request_body_min:
$ref: '#/components/examples/bank_document_verification_creation_request_body_min'
bank_document_verification_creation_request_body_max:
$ref: '#/components/examples/bank_document_verification_creation_request_body_max'
schema:
$ref: '#/components/schemas/BankDocumentVerificationInputPost'
responses:
'201':
description: Bank Document Verification created successfully
content:
application/json:
examples:
bank_document_verification_creation_response_body:
$ref: '#/components/examples/bank_document_verification_creation_response_body'
schema:
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationOutputPost'
'400':
description: Bad request
'401':
description: Unauthorized
'422':
description: Unprocessable entity
'500':
description: Internal server error
'503':
description: Service unavailable
/v2/bank-document-verifications/{bank_document_verification_id}:
get:
tags:
- Bank document verifications (Coming soon)
summary: Retrieve a Bank Document Verification
description: This endpoint allows you to get the detailed results of a Bank Document Verification
operationId: retrieve_bank_document_verification
parameters:
- name: bank_document_verification_id
in: path
required: true
schema:
$ref: '#/components/schemas/BankDocumentVerificationId'
responses:
'200':
description: Bank Document Verification retrieved successfully
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationOutputGet'
'404':
description: Bank Document Verification not found
'500':
description: Internal server error
/v2/bank-document-verifications/{bank_document_verification_id}/anonymize:
post:
tags:
- Bank document verifications (Coming soon)
summary: Anonymize a Bank Document Verification
operationId: anonymize_bank_document_verification
description: Anonymize the personal data of a Bank Document Verification with the specified ID.
parameters:
- name: bank_document_verification_id
in: path
description: ID of the document verification to anonymize
required: true
schema:
type: string
responses:
'200':
description: Bank Document Verification anonymized
content:
application/json:
examples:
bank_document_verification_anonymization_response_body:
$ref: '#/components/examples/bank_document_verification_anonymization_response_body'
schema:
required:
- applicant_id
- user_journey_id
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationOutputAnonymize'
'404':
description: Bank Document Verification not found
'500':
description: Internal server error
/v2/bank-document-verifications/{bank_document_verification_id}/attempts:
get:
tags:
- Bank document verifications (Coming soon)
summary: List Bank Document Verification attempts
operationId: list_attempts_bank_document_verification
description: 'This endpoint allows you to list all attempts of a Bank Document Verification.
Attempts are returned ordered by creation date, newest first.
The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
'
parameters:
- name: bank_document_verification_id
in: path
description: ID of the document verification
required: true
schema:
type: string
- $ref: '#/components/parameters/skipParam'
- $ref: '#/components/parameters/limitParam'
responses:
'200':
description: Bank Document Verification attempts retrieved successfully
content:
application/json:
examples:
bank_document_verification_attempt_list_response_body:
$ref: '#/components/examples/bank_document_verification_attempt_list_response_body'
schema:
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationAttemptOutputList'
'404':
description: The provided document verification ID is not valid
'500':
description: An error occurred while fetching the attempts
post:
tags:
- Bank document verifications (Coming soon)
summary: Create a Bank Document Verification attempt
description: 'This endpoint allows you to create a Bank Document Verification attempt. It is possible when the Bank Document Verification is one of the following statuses: `created`, `retry_required`'
operationId: create_bank_document_verification_attempt
parameters:
- name: bank_document_verification_id
in: path
description: ID of the document verification
required: true
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
examples:
bank_document_verification_attempt_creation_request_body_min:
$ref: '#/components/examples/bank_document_verification_attempt_creation_request_body_min'
bank_document_verification_attempt_creation_request_body_max:
$ref: '#/components/examples/bank_document_verification_attempt_creation_request_body_max'
schema:
$ref: '#/components/schemas/BankDocumentVerificationAttemptInputPost'
responses:
'201':
description: Bank Document Verification attempt created
content:
application/json:
examples:
bank_document_verification_attempt_creation_response_body:
$ref: '#/components/examples/bank_document_verification_attempt_creation_response_body'
schema:
$ref: '#/components/schemas/BankDocumentVerificationAttemptOutputPost'
'404':
description: The provided Bank Document Verification ID is not valid
'409':
description: The Bank Document Verification is not in a valid state to create an attempt. The Bank Document Verification status must be `created` or `retry_required`
'500':
description: An error occurred while creating the attempt
/v2/bank-document-verifications/{bank_document_verification_id}/attempts/{attempt_id}:
get:
tags:
- Bank document verifications (Coming soon)
summary: Retrieve a Bank Document Verification attempt
description: This endpoint allows you to retrieve the details for a given Bank Document Verification attempt.
operationId: fetch_attempts_bank_document_verification
parameters:
- name: bank_document_verification_id
in: path
description: ID of the document verification
required: true
schema:
type: string
- name: attempt_id
in: path
description: ID of the document verification attempt
required: true
schema:
type: string
responses:
'200':
description: Bank Document Verification attempt retrieved successfully
content:
application/json:
examples:
bank_document_verification_attempt_get_response_body:
$ref: '#/components/examples/bank_document_verification_attempt_get_response_body'
schema:
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationAttemptOutputGet'
'404':
description: The provided document verification attempt ID is not valid
'500':
description: An error occurred while fetching the attempt
/v2/bank-document-verifications/{bank_document_verification_id}/attempts/{attempt_id}/assets:
get:
tags:
- Bank document verifications (Coming soon)
summary: Retrieve a Bank Document Verification attempt asset
operationId: fetch_asset_bank_document_verification_attempt
description: 'This endpoint allows you to retrieve the assets associated with a Bank Document Verification.
This includes the document image.
The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
'
parameters:
- name: bank_document_verification_id
in: path
description: ID of the Bank Document Verification
required: true
schema:
type: string
- name: attempt_id
in: path
description: ID of the Bank Document Verification attempt
required: true
schema:
type: string
- $ref: '#/components/parameters/skipParam'
- $ref: '#/components/parameters/limitParam'
responses:
'200':
description: Bank Document Verification attempt asset retrieved successfully
content:
application/json:
examples:
bank_document_verification_attempt_output_assets_response_body:
$ref: '#/components/examples/bank_document_verification_attempt_output_assets_response_body'
schema:
$ref: '#/components/schemas/BankDocumentVerificationAttemptAssetsOutput'
/v2/bank-document-verifications/{bank_document_verification_id}/notify:
post:
tags:
- Bank document verifications (Coming soon)
summary: Request webhook notification
operationId: notify_bank_document_verification
description: This endpoint can be used to initiate a webhook call containing the latest event of a Bank Document Verification
parameters:
- name: bank_document_verification_id
in: path
description: ID of the document verification to notify
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
webhook_url:
type: string
format: uri
responses:
'204':
description: Notification successfully requested
/v2/bank-document-verifications/{bank_document_verification_id}/pdf-report:
get:
tags:
- Bank document verifications (Coming soon)
summary: Retrieve PDF report of a Bank Document Verification
operationId: pdf_bank_document_verification
description: 'This endpoint allows you to retrieve a PDF report of a Bank Document Verification.
Please note that the PDF report is only available for bank document verifications that are
in status `declined` and `approved` once you receive the `bank_document_verification_report_created` event.
'
parameters:
- name: bank_document_verification_id
in: path
description: ID of the Bank Document Verification
required: true
schema:
type: string
responses:
'200':
description: Bank Document Verification PDF report retrieved successfully
content:
application/json:
examples:
bank_document_verification_pdf_report_response_body:
$ref: '#/components/examples/bank_document_verification_pdf_report_response_body'
schema:
$ref: '#/components/schemas/BankDocumentVerificationOutputPdfReport'
'404':
description: The PDF report is not available
components:
examples:
bank_document_verification_attempt_list_response_body:
value:
total_count: 2
skip: 10
limit: 10
data:
- id: bdv_tkoi5db4hryu5cei5vwoabr7we
created_on: 2017-07-21 17:32:28+00:00
modified_on: 2017-07-21 17:40:32+00:00
status: completed
response_codes: []
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts
next:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/...
previous:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/...
bank_document_verification_attempt_creation_response_body:
value:
id: bdv_tkoi5db4hryu5cei5vwoabr7we
created_on: 2017-07-21 17:32:28+00:00
modified_on: 2017-07-21 17:40:32+00:00
status: completed
response_codes: []
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123
bank_document_verification_attempt_output_assets_response_body:
value:
total_count: 1
skip: 10
limit: 10
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets
next:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/...
previous:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/...
data:
- type: document
_links:
asset_url:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/document
bank_document_verification_anonymization_response_body:
value:
id: bdv_tkoi5db4hryu5cei5vwoabr7we
created_on: 2017-07-21 17:32:28+00:00
modified_on: 2017-07-21 17:40:32+00:00
user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
status: created
response_codes: []
webhook_url: https://my.api/events/
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we
bank_document_verification_pdf_report_response_body:
value:
pdf_report: https://www.example.com/reports/bdv_123.pdf
bank_document_verification_attempt_creation_request_body_min:
value:
document: 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…
'
bank_document_verification_attempt_get_response_body:
value:
id: bdv_tkoi5db4hryu5cei5vwoabr7we
created_on: 2017-07-21 17:32:28+00:00
modified_on: 2017-07-21 17:40:32+00:00
status: completed
response_codes: []
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123
bank_document_verification_attempt_creation_request_body_max:
value:
document: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…
'
bank_document_verification_creation_response_body:
value:
id: bdv_tkoi5db4hryu5cei5vwoabr7we
created_on: '2017-07-21T17:32:28Z'
modified_on: '2017-07-21T17:40:32Z'
user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
status: created
response_codes: []
declared_data:
registered_name: Acme Corporation
trading_name: Acme Corp
bank_document:
bank_account_number: '1234567890'
bank_routing_number: '987654321'
account_type: checking
legal_name: Acme Corporation
bank_name: First National Bank
issue_date: 2023-01-15
document_type: bank_statement
webhook_url: https://my.api/events/
_links:
self:
href: https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we
bank_document_verification_creation_request_body_min:
value:
user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
declared_data:
registered_name: Acme Corporation
trading_name: Acme Corp
bank_document_verification_creation_request_body_max:
value:
user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
declared_data:
registered_name: Acme Corporation
trading_name: Acme Corp
webhook_url: https://my.api/events/
schemas:
BankDocumentVerificationInputBase:
type: object
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationBase'
BankDocumentVerificationAttemptOutputList:
type: object
required:
- total_count
- skip
- limit
- _links
- data
properties:
data:
type: array
description: Array of Bank Document Verification attempts for the current page
minItems: 0
items:
$ref: '#/components/schemas/BankDocumentVerificationAttemptOutputGet'
allOf:
- $ref: '#/components/schemas/BaseOutputList'
BankDocumentVerificationAttemptOutputBase:
type: object
properties:
id:
type: string
status:
$ref: '#/components/schemas/BankDocumentVerificationAttemptStates'
response_codes:
type: array
minItems: 0
items:
$ref: '#/components/schemas/ResponseCodes'
_links:
$ref: '#/components/schemas/SelfLink'
allOf:
- $ref: '#/components/schemas/DatedObject'
BankDocumentVerificationLinks:
type: object
allOf:
- $ref: '#/components/schemas/SelfLink'
AccountTypes:
type: string
description: Type of account.
enum:
- checking
- savings
RiskLabels:
type: array
items:
$ref: '#/components/schemas/RiskLabel'
description: Risk assessment labels
CountryCodeIso2:
type: string
format: ISO 3166-1 alpha-2
pattern: ^[A-Za-z]{2}$
example: US
UserJourneyId:
type: string
description: User journey unique identifier.
pattern: ^usj_\w+$
example: usj_tkoi5db4hryu5cei5vwoabr7we
ListLinks:
type: object
required:
- self
properties:
self:
description: Link to the current page
$ref: '#/components/schemas/HalLink'
previous:
description: Link to the previous page (null if on the first page)
$ref: '#/components/schemas/HalLink'
next:
description: Link to the next page (null if on the last page)
$ref: '#/components/schemas/HalLink'
RiskLabel:
type: string
description: Risk assessment label.
enum:
- multiple_faces_detected
- mcc_not_confident
- risky_document_format
BankDocumentVerificationId:
type: string
description: Bank Document Verification unique identifier.
pattern: ^bdv_\w+$
example: bdv_tkoi5db4hryu5cei5vwoabr7we
BankDocumentVerificationOutputAnonymize:
type: object
required:
- id
- status
- applicant_id
- user_journey_id
- response_codes
- _links
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationOutputBase'
BankDocument:
type: object
properties:
bank_account_number:
type: string
maxLength: 255
bank_routing_number:
type: string
maxLength: 255
account_type:
$ref: '#/components/schemas/AccountTypes'
company_name:
type: string
minLength: 2
maxLength: 510
bank_name:
type: string
minLength: 2
maxLength: 510
issue_date:
type: string
format: date
document_type:
$ref: '#/components/schemas/BankDocumentType'
company_address:
$ref: '#/components/schemas/Address'
BankDocumentVerificationAttemptStates:
type: string
description: Bank Document Verification attempt state.
enum:
- quality_checks_in_progress
- checks_in_progress
- completed
- quality_checks_aborted
- checks_inconclusive
- terminated
SelfLink:
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/HalLink'
ResponseSummary:
type: string
description: A descriptive code of the response code.
BankDocumentVerificationAttemptInputPost:
type: object
required:
- document
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationAttemptInputBase'
Address:
type: object
properties:
address_line1:
type: string
maxLength: 250
address_line2:
type: string
maxLength: 250
city:
type: string
maxLength: 50
state:
type: string
maxLength: 50
zip:
type: string
maxLength: 50
country:
$ref: '#/components/schemas/CountryCodeIso2'
BankDocumentVerificationOutputPdfReport:
type: object
required:
- pdf_report
properties:
pdf_report:
type: string
format: uri
BankDocumentVerificationAttemptAssetsOutput:
type: object
required:
- total_count
- skip
- limit
- _links
- data
properties:
data:
type: array
description: Array of Bank Document Verification attempt assets for the current page
minItems: 0
items:
$ref: '#/components/schemas/BankDocumentVerificationAttemptAsset'
allOf:
- $ref: '#/components/schemas/BaseOutputList'
BankDocumentVerificationInputPost:
type: object
required:
- applicant_id
- user_journey_id
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationInputBase'
BankDocumentVerificationOutputPost:
type: object
required:
- id
- status
- applicant_id
- response_codes
- user_journey_id
- _links
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationOutputBase'
BankDocumentVerificationStatus:
type: string
description: Bank Document Verification status.
enum:
- created
- quality_checks_in_progress
- checks_in_progress
- approved
- declined
- retry_required
- inconclusive
ResponseCodes:
type: object
description: The code giving more details about the result.
properties:
code:
$ref: '#/components/schemas/ResponseCode'
summary:
$ref: '#/components/schemas/ResponseSummary'
required:
- code
- summary
BankDocumentType:
type: string
description: Type of document.
enum:
- bank_statement
- bank_letter
BaseOutputList:
type: object
properties:
total_count:
type: integer
description: Total number of items available across all pages
skip:
type: integer
description: Number of items skipped (offset from the start)
limit:
type: integer
description: Maximum number of items returned in this page
_links:
$ref: '#/components/schemas/ListLinks'
ResponseCode:
type: integer
description: The numeric code of the response code.
minimum: 10000
maximum: 69999
BankDocumentVerificationOutputBase:
type: object
properties:
id:
$ref: '#/components/schemas/BankDocumentVerificationId'
status:
$ref: '#/components/schemas/BankDocumentVerificationStatus'
response_codes:
type: array
items:
$ref: '#/components/schemas/ResponseCodes'
risk_labels:
$ref: '#/components/schemas/RiskLabels'
bank_document:
$ref: '#/components/schemas/BankDocument'
_links:
$ref: '#/components/schemas/BankDocumentVerificationLinks'
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationBase'
- $ref: '#/components/schemas/DatedObject'
HalLink:
type: object
required:
- href
properties:
href:
type: string
format: uri
BankDocumentVerificationOutputGet:
type: object
required:
- id
- status
- applicant_id
- response_codes
- user_journey_id
- _links
allOf:
- $ref: '#/components/schemas/DatedObject'
- $ref: '#/components/schemas/BankDocumentVerificationOutputBase'
BankDocumentVerificationAttemptAsset:
type: object
required:
- type
- _links
properties:
type:
type: string
description: Type of asset
enum:
- document
_links:
type: object
properties:
asset_url:
type: object
properties:
href:
type: string
format: uri
BankDocumentVerificationDeclaredData:
type: object
required:
- registered_name
- trading_name
properties:
registered_name:
type: string
minLength: 2
maxLength: 255
trading_name:
type: string
minLength: 2
maxLength: 255
BankDocumentVerificationAttemptOutputPost:
type: object
required:
- id
- status
- response_codes
- _links
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationAttemptOutputBase'
DatedObject:
type: object
required:
- created_on
- modified_on
properties:
created_on:
description: UTC Date time when the resource was created
type: string
format: date-time
example: 2017-07-21 17:32:28+00:00
modified_on:
description: UTC Date time when the resource was modified
type: string
format: date-time
example: 2017-07-21 17:40:32+00:00
BankDocumentVerificationBase:
type: object
properties:
user_journey_id:
allOf:
- $ref: '#/components/schemas/UserJourneyId'
applicant_id:
allOf:
- $ref: '#/components/schemas/BusinessApplicantId'
webhook_url:
type: string
format: uri
declared_data:
$ref: '#/components/schemas/BankDocumentVerificationDeclaredData'
BankDocumentVerificationAttemptOutputGet:
type: object
required:
- id
- status
- response_codes
- _links
allOf:
- $ref: '#/components/schemas/BankDocumentVerificationAttemptOutputBase'
BusinessApplicantId:
type: string
description: Business Applicant unique identifier.
pattern: ^bplt_\w+$
example: bplt_tkoi5db4hryu5cei5vwoabr7we
BankDocumentVerificationAttemptInputBase:
type: object
properties:
document:
type: string
format: binary
parameters:
skipParam:
name: skip
in: query
description: Number of items to skip (offset)
required: false
schema:
type: integer
minimum: 0
default: 0
limitParam:
name: limit
in: query
description: Maximum number of items to return per page
required: false
schema:
type: integer
minimum: 1
default: 10
x-tagGroups:
- name: Endpoints documentation
tags:
- Applicants
- Business applicants
- Identity verifications
- ID document verifications
- Face authentications
- AML verifications
- Website verifications (Coming soon)
- Bank document verifications (Coming soon)
- Company document verifications (Coming soon)
- Address document verifications (Coming soon)
- Service status