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
  • Upload live photo
  • Example request

Was this helpful?

  1. Live Photos

Upload a live photo

Upload live photo

POST https://api.complycube.com/v1/livePhotos

Uploads a new live photo. The live photo image must be either in JPG or PNG format. The size must be between 34 KB and 4 MB.

Headers

Name
Type
Description

Content-Type

string

The content-type must always be set to application/json.

Authorization

string

The API live or test key

Request Body

Name
Type
Description

clientId

string

The ID of the client associated with this live photo.

data

string

The BASE64 encoded data.

{
    "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"
}
{
    "type": "invalid_request",
    "message": "Image file size should be between 34KB and 4MB",
    "param": "data"
}

Example request

curl -X POST https://api.complycube.com/v1/livePhotos \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"clientId":"5eb1276d96be4a0008713af5",
          	"data": "<BASE64_DATA_CONTENT>"
        }' 
const { ComplyCube } = require("@complycube/api");

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

await complycube.livePhoto.upload("5eb1276d96be4a0008713af5", {
    data: "<BASE64_CONTENT>"
});
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

live_photo = cc_api.livephotos.upload('CLIENT_ID',{ data: '<BASE64_CONTENT>'})
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$img = $ccapi->livephotos()->upload('CLIENT_ID',['data' => '<BASE64_CONTENT>']);
PreviousLive PhotosNextGet a live photo

Last updated 4 years ago

Was this helpful?