ID Liveness API

import base64
import requests

url = "https://idverify-api.argosidentity.com/modules/document"
image_path = "/path/to/id_image.png"
api_key = "YOUR_API_KEY"

with open(image_path, "rb") as f:
    encoded = base64.b64encode(f.read()).decode("utf-8")

payload = {
    "idImage": encoded,
    "pipelines": {"sr": True, "pc": True, "ps": True},
}
headers = {
    "x-api-key": api_key,
    "Content-Type": "application/json",
}

response = requests.post(url, json=payload, headers=headers, timeout=60)
print(response.status_code)
print(response.text)

# Encode the image as a single-line base64 string (works on Linux and macOS)
IMAGE_B64=$(base64 < /path/to/id_image.png | tr -d '\n')

# Write the JSON body to a file; a large base64 string can exceed the shell's argument length limit
printf '{"idImage":"%s","pipelines":{"sr":true,"pc":true,"ps":true}}' "$IMAGE_B64" > body.json

curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/document \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data @body.json

const fs = require("fs");

const url = "https://idverify-api.argosidentity.com/modules/document";
const imagePath = "/path/to/id_image.png";
const apiKey = "YOUR_API_KEY";

const encoded = fs.readFileSync(imagePath).toString("base64");

fetch(url, {
  method: "POST",
  headers: {
    "x-api-key": apiKey,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    idImage: encoded,
    pipelines: { sr: true, pc: true, ps: true },
  }),
})
  .then(async (res) => {
    console.log(res.status);
    console.log(await res.text());
  })
  .catch((err) => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://idverify-api.argosidentity.com/modules/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idImage' => 'base64_encoded_id_document_image',
    'pipelines' => [
        'sr' => true,
        'pc' => true,
        'ps' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://idverify-api.argosidentity.com/modules/document"

	payload := strings.NewReader("{\n  \"idImage\": \"base64_encoded_id_document_image\",\n  \"pipelines\": {\n    \"sr\": true,\n    \"pc\": true,\n    \"ps\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://idverify-api.argosidentity.com/modules/document")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idImage\": \"base64_encoded_id_document_image\",\n  \"pipelines\": {\n    \"sr\": true,\n    \"pc\": true,\n    \"ps\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://idverify-api.argosidentity.com/modules/document")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idImage\": \"base64_encoded_id_document_image\",\n  \"pipelines\": {\n    \"sr\": true,\n    \"pc\": true,\n    \"ps\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "apiType": "id_live_doc",
  "transactionId": "txn_123456789",
  "engineVersion": "id_liveness@3.4.2",
  "result": {
    "screenReplay": {
      "liveness_score": 99
    },
    "paperPrinted": {
      "liveness_score": 82
    },
    "replacePortraits": {
      "liveness_score": 100
    }
  }
}

{
  "transactionId": "txn_123456789",
  "engineVersion": "id_liveness@3.4.2",
  "message": "request has been successfully received. The response will be sent to your callback URL"
}

{
  "error": {
    "statusCode": 400,
    "apiType": "id_live_doc",
    "transactionId": "txn_123456789",
    "engineVersion": "id_liveness@3.4.2",
    "errorCode": "1003",
    "message": "Fail to process data"
  }
}

{
  "error": {
    "transactionId": "txn_123456789",
    "errorCode": "1001",
    "message": "Workspace is unavailable"
  }
}