curl -X POST 'https://verification.didit.me/v3/blocklist/add/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"session_id": "33333333-4444-5555-6666-777777777777",
"blocklist_face": true,
"blocklist_document": true
}'import os
import requests
resp = requests.post(
'https://verification.didit.me/v3/blocklist/add/',
headers={'x-api-key': os.environ['DIDIT_API_KEY']},
json={
'session_id': '33333333-4444-5555-6666-777777777777',
'blocklist_face': True,
'blocklist_document': True,
},
timeout=10,
)
resp.raise_for_status()
print(resp.json()['message'])const resp = await fetch('https://verification.didit.me/v3/blocklist/add/', {
method: 'POST',
headers: {
'x-api-key': process.env.DIDIT_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
session_id: '33333333-4444-5555-6666-777777777777',
blocklist_face: true,
blocklist_document: true,
}),
});
if (!resp.ok) throw new Error(`Blocklist failed: ${resp.status} ${await resp.text()}`);
console.log((await resp.json()).message);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verification.didit.me/v3/blocklist/add/",
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([
'session_id' => '33333333-4444-5555-6666-777777777777',
'blocklist_face' => true,
'blocklist_document' => 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://verification.didit.me/v3/blocklist/add/"
payload := strings.NewReader("{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\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://verification.didit.me/v3/blocklist/add/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/blocklist/add/")
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 \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\n}"
response = http.request(request)
puts response.read_body{
"message": "Successfully updated blocklist."
}Add to Blocklist
POST /v3/blocklist/add/: blocklist the face, document, phone number or email of a Didit verification session so matching new sessions are declined.
curl -X POST 'https://verification.didit.me/v3/blocklist/add/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"session_id": "33333333-4444-5555-6666-777777777777",
"blocklist_face": true,
"blocklist_document": true
}'import os
import requests
resp = requests.post(
'https://verification.didit.me/v3/blocklist/add/',
headers={'x-api-key': os.environ['DIDIT_API_KEY']},
json={
'session_id': '33333333-4444-5555-6666-777777777777',
'blocklist_face': True,
'blocklist_document': True,
},
timeout=10,
)
resp.raise_for_status()
print(resp.json()['message'])const resp = await fetch('https://verification.didit.me/v3/blocklist/add/', {
method: 'POST',
headers: {
'x-api-key': process.env.DIDIT_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
session_id: '33333333-4444-5555-6666-777777777777',
blocklist_face: true,
blocklist_document: true,
}),
});
if (!resp.ok) throw new Error(`Blocklist failed: ${resp.status} ${await resp.text()}`);
console.log((await resp.json()).message);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verification.didit.me/v3/blocklist/add/",
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([
'session_id' => '33333333-4444-5555-6666-777777777777',
'blocklist_face' => true,
'blocklist_document' => 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://verification.didit.me/v3/blocklist/add/"
payload := strings.NewReader("{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\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://verification.didit.me/v3/blocklist/add/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/blocklist/add/")
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 \"session_id\": \"33333333-4444-5555-6666-777777777777\",\n \"blocklist_face\": true,\n \"blocklist_document\": true\n}"
response = http.request(request)
puts response.read_body{
"message": "Successfully updated blocklist."
}400 and nothing is blocklisted. Repeating the call for an item that is already blocklisted is safe.Authorizations
Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.
Body
At least one blocklist_* flag must be true.
A person verification session of your application. Deleted sessions are refused.
Blocklist the session's face.
Blocklist the session's identity document. The document needs its issuing state, document type, document number and full name.
Blocklist the session's phone number.
Blocklist the session's email address.
Response
The selected items were blocklisted.
Always Successfully updated blocklist.