API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox 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
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page

Was this helpful?

Live Photos

A necessity for a smooth Identity Check user experience.

PreviousFiltering documentsNextUpload a live photo

Last updated 4 years ago

Was this helpful?

Live Photos are images 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.

  • Glare Detection: checks if a face has a glare.

  • 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.

downloadLink

string

contentType

string

size

number

createdAt

string

The date and time when the live photo was created.

updatedAt

string

The date and time when the live photo was updated.

{
    "id": "5eb1b5f231778a0008d1c3f6",
    "clientId": "5eb1276d96be4a0008713af5",
    "downloadLink": "/livePhotos/5eb1b5f231778a0008d1c3f6/download",
    "contentType": "images/jpg",
    "size": 44896,
    "createdAt": "2020-01-01T14:06:44.756Z",
    "updatedAt": "2020-01-01T14:06:44.756Z"
}

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

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

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

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