API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page

Was this helpful?

  1. Core resources

Live Photos

A necessity for a smooth Identity Check user experience.

PreviousFiltering documentsNextUpload a live photo

Last updated 1 year ago

Was this helpful?

Live Photos are images (i.e. selfies) of the client's face. Typically, along with an ID document, they are used to perform .

Upon creating a Live Photo, the following inspections are conducted:

  • Faces Analysis: checks if a face is detected and that the number of faces does not exceed 1.

  • Facial Obstructions: checks if facial features are covered or not visible.

  • Facial Orientation: checks if a face is at an optimal position.

  • Liveness Check: checks if a photo is genuine and is not a spoofed photo of an image or photo-of-a-photo.

The live photos API allows you to upload, retrieve, download, and delete live photos. You can retrieve a specific live photo as well as a list of all your client's live photos.

The Live Photo object

Attribute
Type
Description

id

string

The unique identifier for a live photo.

clientId

string

The ID of the client associated with this live photo.

performLivenessCheck

boolean

Indicates if a liveness check should be performed on a live photo upload. When not provided, this defaults to true.

downloadLink

string

The URI can be used to . This will be automatically generated upon a successful .

contentType

string

The MIME type of the image. This will be automatically set upon a successful .

size

number

The size of the live photo in bytes. This will be automatically set upon a successful .

createdAt

string

The date and time when the live photo was created.

updatedAt

string

The date and time when the live photo was updated.

Identity Checks
download the live photo
live photo upload
live photo upload
live photo upload