Update Session Status
curl --request PATCH \
--url https://api.deepidv.com/v1/sessions/{id}/update-statusimport requests
url = "https://api.deepidv.com/v1/sessions/{id}/update-status"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.deepidv.com/v1/sessions/{id}/update-status', 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://api.deepidv.com/v1/sessions/{id}/update-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$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://api.deepidv.com/v1/sessions/{id}/update-status"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.deepidv.com/v1/sessions/{id}/update-status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/sessions/{id}/update-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body{
"session_record": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "org_abc123",
"user_id": "usr_def456",
"sender_user_id": "usr_ghi789",
"external_id": "user-12345",
"status": "VERIFIED",
"type": "verification",
"session_progress": "COMPLETED",
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T11:00:00.000Z"
}
}
Sessions
Update Session Status
Manually update a session’s status to VERIFIED or REJECTED
PATCH
/
v1
/
sessions
/
{id}
/
update-status
Update Session Status
curl --request PATCH \
--url https://api.deepidv.com/v1/sessions/{id}/update-statusimport requests
url = "https://api.deepidv.com/v1/sessions/{id}/update-status"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.deepidv.com/v1/sessions/{id}/update-status', 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://api.deepidv.com/v1/sessions/{id}/update-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$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://api.deepidv.com/v1/sessions/{id}/update-status"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.deepidv.com/v1/sessions/{id}/update-status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/sessions/{id}/update-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body{
"session_record": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "org_abc123",
"user_id": "usr_def456",
"sender_user_id": "usr_ghi789",
"external_id": "user-12345",
"status": "VERIFIED",
"type": "verification",
"session_progress": "COMPLETED",
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T11:00:00.000Z"
}
}
PATCH /v1/sessions/{id}/update-status
VERIFIED or REJECTED.
Request
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The session ID (returned as id when the session was created) |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
new_status | string | Yes | The new status to set. Must be VERIFIED or REJECTED |
Example request
curl -X PATCH https://api.deepidv.com/v1/sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-status \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"new_status": "VERIFIED"}'
const response = await fetch(
"https://api.deepidv.com/v1/sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-status",
{
method: "PATCH",
headers: {
"x-api-key": "YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({ new_status: "VERIFIED" }),
}
);
const data = await response.json();
import requests
response = requests.patch(
"https://api.deepidv.com/v1/sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-status",
headers={"x-api-key": "YOUR_API_KEY"},
json={"new_status": "VERIFIED"},
)
Response
200 — Success
Response fields
| Field | Type | Description |
|---|---|---|
session_record | object | The updated session object (same shape as the session_record in the Retrieve Session response). Does not include resource_links, user, or sender_user |
Error responses
| Status | Description |
|---|---|
400 Bad Request | Invalid session ID or new_status value. Must be VERIFIED or REJECTED |
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Session belongs to a different organization |
404 Not Found | Session ID does not exist |
429 Too Many Requests | Rate limit exceeded |
{
"session_record": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "org_abc123",
"user_id": "usr_def456",
"sender_user_id": "usr_ghi789",
"external_id": "user-12345",
"status": "VERIFIED",
"type": "verification",
"session_progress": "COMPLETED",
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T11:00:00.000Z"
}
}
⌘I