Get a live photo

This will retrieve the live photo object. To download the actual photo, you should use the download live photo endpoint.

URL

GET https://api.complycube.com/v1/livePhotos/:id

Retrieves an existing live photo.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Path parameters

Name	Type	Description
id*	string	The ID of the live photo.

Example request

cURL

curl -X GET https://api.complycube.com/v1/livePhotos/{:livePhotoId} \
     -H 'Authorization: <YOUR_API_KEY>'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const livePhoto = await complycube.livePhoto.get("LIVE_PHOTO_ID");

Python

from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

live_photo = cc_api.livephotos.get('LIVE_PHOTO_ID')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$livePhoto = $ccapi->livephotos()->get('LIVE_PHOTO_ID');

.NET

using ComplyCube.Net;
using ComplyCube.Net.Resources.LivePhotos;

var livePhotoApi = new LivePhotoApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var livePhoto = await livePhotoApi.GetAsync("LIVE_PHOTO_ID");

Example responses

Success (200)

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

Resource Not Found (404)

{
    "type": "resource_not_found",
    "message": "Invalid live photo id '5eb1b5f231778a0008d1c3f5'"
}