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 Face authentications API

The Face authentications API from Ubble — 7 operation(s) for face authentications.

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

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

This API exposes 8 operations across 7 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

8 operations 7 paths 45 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 8

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

Face authentications 8
POST
/v2/face-authentications
Create a face authentication
create_face_authentication body → 201400500
GET
/v2/face-authentications/{face_authentication_id}
Retrieve a face authentication
retrieve_face_authentication 1 param → 200404500
POST
/v2/face-authentications/{face_authentication_id}/anonymize
Anonymize a face authentication
anonymize_face_authentication 1 param → 200404400500
GET
/v2/face-authentications/{face_authentication_id}/attempts
List attempts
list_attempts_face_authentication 3 params → 200404500
POST
/v2/face-authentications/{face_authentication_id}/attempts
Create an attempt
create_attempt_face_authentication 1 param body → 201404409500
GET
/v2/face-authentications/{face_authentication_id}/attempts/{attempt_id}
Retrieve an attempt
fetch_attempts_face_authentication 2 params → 200404500
GET
/v2/face-authentications/{face_authentication_id}/attempts/{attempt_id}/assets
Retrieve attempt assets
retrieve_face_authentication_attempt_assets 4 params → 200
POST
/v2/face-authentications/{face_authentication_id}/notify
Request webhook notification
notify_face_authentication 1 param body → 204

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are FaceAuthenticationOutputBase (6 properties), FaceAuthenticationAttemptOutputBase (5 properties), BaseApplicantSessionInformation (4 properties), BaseOutputList (4 properties). Each schema is shown below with its type and property counts.

RiskLabel
string
Risk assessment label.
FaceAuthenticationOutputPost
object
1 property 8 required
FaceAuthenticationOutputGet
object
8 required
FaceAuthenticationApplicantSessionInformation
object
SelfLink
object
1 property 1 required
DomesticPhoneNumber
string
FaceAttemptBase
object
3 properties
InitialDevices
string
Initial device which started the session
FaceAuthenticationAttemptOutputPost
object
5 required
PhoneNumber
object
2 properties 2 required
FaceAuthenticationAttemptAssetOutput
object
2 properties 2 required
ApplicantId
string
Applicant unique identifier.
FaceAuthenticationOutputBase
object
6 properties
FaceAuthenticationInputPost
object
3 required
CountryCodeIso2
string
BaseApplicantSessionInformation
object
4 properties
ResponseCodes
object
The code giving more details about the result.
2 properties 2 required
PhonePrefix
string
LanguageCode
string
Language tag following IETF BCP 47 standard
FaceAuthenticationAttemptOutputGet
object
5 required
FaceAuthenticationAttemptInputPost
object
1 required
FaceAuthenticationId
string
Face authentication unique identifier.
BaseOutputList
object
4 properties
VerificationStatuses
string
Status of the verification.
FaceAuthenticationLinks
object
ActiveLink
object
1 property 1 required
HalLink
object
1 property 1 required
FaceAttemptClientInformation
object
2 properties
ResponseSummary
string
A descriptive code of the response code.
ListLinks
object
3 properties 1 required
FaceAuthenticationAttemptInputBase
object
VerificationFace
object
1 property
FaceAuthenticationAttemptOutputBase
object
5 properties
AttemptLinks
object
DatedObject
object
2 properties 2 required
FaceAuthenticationAttemptAssetsOutput
object
1 property 5 required
FaceAuthenticationOutputAnonymize
object
1 property 8 required
UserJourneyId
string
User journey unique identifier.
ResponseCode
integer
The numeric code of the response code.
AttemptStates
string
States of an attempt.
ApplicantLink
object
1 property 1 required
FaceAuthenticationInputBase
object
RiskLabels
array
Risk assessment labels
FaceAuthenticationAttemptResponseList
object
1 property 5 required
FaceAuthenticationBase
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ubble-face-authentications-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 ID document verifications 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 Face authentications 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.