How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ubble ID document verifications API

API for ID document verification

Ubble ID document verifications API is one of 11 APIs that Ubble publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ID document verifications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 8 paths, and defines 37 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.ubble.ai.

9 operations 8 paths 37 schemas 5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.ubble.ai
Resource Areas
1

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

ID document verifications 9

API for ID document verification

POST
/v2/id-document-verifications
Create an ID document verification
create_id_document_verification body → 201400401422500503
GET
/v2/id-document-verifications/{id_document_verification_id}
Retrieve an ID document verification
retrieve_id_document_verification 1 param → 200404500
POST
/v2/id-document-verifications/{id_document_verification_id}/anonymize
Anonymize an ID document verification
anonymize_id_document_verification 1 param → 200404500
GET
/v2/id-document-verifications/{id_document_verification_id}/attempts
List ID document verification attempts
list_attempts_id_document_verification 3 params → 200404500
POST
/v2/id-document-verifications/{id_document_verification_id}/attempts
Create an ID document verification attempt
create_id_document_verification_attempt 1 param body → 201404409500
GET
/v2/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}
Retrieve an ID document verification attempt
fetch_attempts_id_document_verification 2 params → 200404500
GET
/v2/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}/assets
Retrieve an ID document verification attempt asset
fetch_asset_id_document_verification_attempt 4 params → 200
POST
/v2/id-document-verifications/{id_document_verification_id}/notify
Request webhook notification
notify_id_document_verification 1 param body → 204
GET
/v2/id-document-verifications/{id_document_verification_id}/pdf-report
Retrieve PDF report of an ID document verification
pdf_id_document_verification 1 param → 200404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Document (25 properties), IdDocumentVerificationOutputBase (5 properties), IdDocumentVerificationBase (4 properties), BaseOutputList (4 properties). Each schema is shown below with its type and property counts.

DocumentTypes
string
Type of document.
IdDocumentVerificationStatus
string
ID document verification status.
IdDocumentVerificationAttemptOutputGet
object
4 required
IdDocumentVerificationAttemptOutputBase
object
4 properties
IdDocumentVerificationAttemptStates
string
ID document verification attempt state.
DeclaredData
object
2 properties 1 required
IdDocumentVerificationOutputGet
object
6 required
IdDocumentVerificationAttemptOutputList
object
1 property 5 required
CountryCodeIso2
string
Document
object
25 properties
UserJourneyId
string
User journey unique identifier.
ListLinks
object
3 properties 1 required
IdDocumentVerificationInputBase
object
IdDocumentVerificationAttemptInputPost
object
1 required
Gender
string
Person gender.
SelfLink
object
1 property 1 required
ResponseSummary
string
A descriptive code of the response code.
IdDocumentVerificationAttemptAssetsOutput
object
1 property 5 required
IdDocumentVerificationAttemptOutputPost
object
4 required
IdDocumentVerificationId
string
ID ocument verification unique identifier.
IdDocumentVerificationLinks
object
ResponseCodes
object
The code giving more details about the result.
2 properties 2 required
ApplicantId
string
Applicant unique identifier.
IdDocumentVerificationOutputBase
object
5 properties
IdDocumentVerificationOutputPdfReport
object
1 property 1 required
ApplicantLink
object
1 property 1 required
IdDocumentVerificationInputPost
object
2 required
ResponseCode
integer
The numeric code of the response code.
BaseOutputList
object
4 properties
IdDocumentVerificationAttemptInputBase
object
2 properties
IdDocumentVerificationBase
object
4 properties
HalLink
object
1 property 1 required
IdDocumentVerificationOutputAnonymize
object
6 required
IdDocumentVerificationOutputPost
object
6 required
PreSignedUrl
string
Pre-signed URL
DatedObject
object
2 properties 2 required
IdDocumentVerificationAttemptOutputAssetOutput
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ubble-id-document-verifications-api-openapi.yml Raw ↑

Other APIs Ubble publishes across the network.

Ubble Address document verifications (Coming soon) API
Ubble AML verifications API
Ubble Applicants API
Ubble Bank document verifications (Coming soon) API
Ubble Business applicants API
Ubble Company document verifications (Coming soon) API
Ubble Face authentications API
Ubble Identity verifications API
Ubble Service status API
Ubble Website verifications (Coming soon) API
Where this information came from

This is an independent, third-party profile of Ubble ID document verifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.