Skip to main content
PATCH
/
v1
/
sessions
/
{id}
/
update-status
Update Session Status
curl --request PATCH \
  --url https://api.deepidv.com/v1/sessions/{id}/update-status
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://sc-docs.deepidv.com/llms.txt

Use this file to discover all available pages before exploring further.

PATCH /v1/sessions/{id}/update-status
Manually updates the status of a verification session to either VERIFIED or REJECTED.

​
Request

​
Headers

HeaderRequiredDescription
x-api-keyYesYour API key

​
Path parameters

ParameterTypeRequiredDescription
idstringYesThe session ID (returned as id when the session was created)

​
Body parameters

ParameterTypeRequiredDescription
new_statusstringYesThe 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"}'

​
Response

​
200 — Success

​
Response fields

FieldTypeDescription
session_recordobjectThe 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

StatusDescription
400 Bad RequestInvalid session ID or new_status value. Must be VERIFIED or REJECTED
401 UnauthorizedMissing or invalid API key
403 ForbiddenSession belongs to a different organization
404 Not FoundSession ID does not exist
429 Too Many RequestsRate 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"
  }
}