curl --request GET \
--url https://verification.didit.me/v3/fraud/checks/{check_id}/ \
--header 'x-api-key: <api-key>'import requests
url = "https://verification.didit.me/v3/fraud/checks/{check_id}/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://verification.didit.me/v3/fraud/checks/{check_id}/', 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://verification.didit.me/v3/fraud/checks/{check_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/fraud/checks/{check_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://verification.didit.me/v3/fraud/checks/{check_id}/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/fraud/checks/{check_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_reference": "<string>",
"processing_status": "pending",
"profile_id": "<string>",
"profile_version": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"inputs": [
{
"reference": "<string>",
"type": "email",
"namespace": {},
"quality": "<string>",
"normalization": {},
"availability": "available"
}
],
"modules": [
{
"module": "normalization",
"status": "planned",
"reason": "<string>",
"latency_ms": 123,
"freshness": "<string>",
"billable_units": 123
}
],
"attribute_evidence": [
{}
],
"compound_evidence": [
{}
],
"risk": [
{
"dimension": "identity",
"score": 123,
"band": "low",
"availability": "available",
"requested_but_unavailable": true,
"reason_codes": [
"<string>"
],
"evidence_indexes": [
123
]
}
],
"network": {},
"recommendation": "approve",
"next_action": "none",
"decision_reasons": [
"<string>"
],
"coverage": {},
"usage": [
{}
],
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enrichment": {},
"identity_relationship": {
"result": "match",
"reference_type": "<string>",
"country": "<string>",
"availability": "available",
"reason_codes": [
"<string>"
]
},
"vendor_data": "<string>",
"metadata": null
}{
"detail": "Authentication failed: Invalid client access token."
}{
"detail": "Forbidden - User doesn't have permission"
}Get a Fraud Check
Retrieve the stored result of a Fraud Check belonging to your application.
curl --request GET \
--url https://verification.didit.me/v3/fraud/checks/{check_id}/ \
--header 'x-api-key: <api-key>'import requests
url = "https://verification.didit.me/v3/fraud/checks/{check_id}/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://verification.didit.me/v3/fraud/checks/{check_id}/', 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://verification.didit.me/v3/fraud/checks/{check_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/fraud/checks/{check_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://verification.didit.me/v3/fraud/checks/{check_id}/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/fraud/checks/{check_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_reference": "<string>",
"processing_status": "pending",
"profile_id": "<string>",
"profile_version": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"inputs": [
{
"reference": "<string>",
"type": "email",
"namespace": {},
"quality": "<string>",
"normalization": {},
"availability": "available"
}
],
"modules": [
{
"module": "normalization",
"status": "planned",
"reason": "<string>",
"latency_ms": 123,
"freshness": "<string>",
"billable_units": 123
}
],
"attribute_evidence": [
{}
],
"compound_evidence": [
{}
],
"risk": [
{
"dimension": "identity",
"score": 123,
"band": "low",
"availability": "available",
"requested_but_unavailable": true,
"reason_codes": [
"<string>"
],
"evidence_indexes": [
123
]
}
],
"network": {},
"recommendation": "approve",
"next_action": "none",
"decision_reasons": [
"<string>"
],
"coverage": {},
"usage": [
{}
],
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enrichment": {},
"identity_relationship": {
"result": "match",
"reference_type": "<string>",
"country": "<string>",
"availability": "available",
"reason_codes": [
"<string>"
]
},
"vendor_data": "<string>",
"metadata": null
}{
"detail": "Authentication failed: Invalid client access token."
}{
"detail": "Forbidden - User doesn't have permission"
}404.
A check belonging to another application also returns 404.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.
Path Parameters
Response
pending- Pendingrunning- Runningcompleted- Completedfailed- Failed
pending, running, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
approve- Approvereview- Reviewreject- Reject
approve, review, reject none- Nonemanual_review- Manual Reviewstep_up- Step Upresubmit_capture- Resubmit Capture
none, manual_review, step_up, resubmit_capture Show child attributes
Show child attributes
Show child attributes
Show child attributes
Native verification session created for this check.
Show child attributes
Show child attributes
Show child attributes
Show child attributes