Poll upload status
curl --request GET \
--url https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"uploadId": "a1b2c3d4-0000-0000-0000-000000000000",
"blacklistId": "95038081-0000-0000-0000-000000000000",
"status": 2,
"statusLabel": "Completed",
"numberOfImages": 3,
"numberOfSucceededImages": 3,
"numberOfFailedImages": 0,
"createdAt": "2026-07-28 03:08:15+0000",
"updatedAt": "2026-07-28 03:09:02+0000"
},
"createdAt": "2026-07-28 03:09:02+0000"
}Internal Blacklist
Poll upload status
Check the status of an asynchronous face enrollment upload until it reaches a terminal state.
GET
/
api
/
v3
/
biometric-blacklists
/
uploads
/
{uploadId}
Poll upload status
curl --request GET \
--url https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment-subdomain}.idmetagroup.com/api/v3/biometric-blacklists/uploads/{uploadId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"uploadId": "a1b2c3d4-0000-0000-0000-000000000000",
"blacklistId": "95038081-0000-0000-0000-000000000000",
"status": 2,
"statusLabel": "Completed",
"numberOfImages": 3,
"numberOfSucceededImages": 3,
"numberOfFailedImages": 0,
"createdAt": "2026-07-28 03:08:15+0000",
"updatedAt": "2026-07-28 03:09:02+0000"
},
"createdAt": "2026-07-28 03:09:02+0000"
}Poll this endpoint with the
uploadId returned from Upload faces until status is a terminal value (2, 3, or 4).
Returns 404 if the upload does not exist or is not owned by your company.
Status values
| Value | Meaning | Terminal? |
|---|---|---|
0 | Pending — queued, not yet started | No |
1 | Processing — enrollment in progress | No |
2 | Completed — all images enrolled | Yes |
3 | Failed — no images enrolled | Yes |
4 | Partially completed — some enrolled, some failed | Yes |
Authorizations
Use Bearer {your_api_token} in the Authorization header, plus HMAC signature headers. Same authentication as other v3 endpoints.
Headers
Example:
"Bearer {your_api_token}"
Path Parameters
The upload UUID returned from the upload faces endpoint.
Example:
"a1b2c3d4-0000-0000-0000-000000000000"

