curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status": "BLOCKED"}'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.users.updateStatus("user-123", {
  status: "ACTIVE",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
	Status: "ACTIVE",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
        .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->updateStatus('user-123', [
    'status' => 'ACTIVE',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
    Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "display_name": null,
  "full_name": "John Michael Doe",
  "date_of_birth": "1990-05-15",
  "effective_name": "John Michael Doe",
  "status": "BLOCKED",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "portrait_image_url": "https://<media-host>/...",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": [
    "USA"
  ],
  "approved_emails": [
    "john@example.com"
  ],
  "approved_phones": [
    "+14155551234"
  ],
  "features": {
    "ID_VERIFICATION": "Approved",
    "LIVENESS": "Approved",
    "FACE_MATCH": "Approved",
    "AML": "Approved"
  },
  "features_list": [
    {
      "feature": "ID_VERIFICATION",
      "status": "Approved"
    },
    {
      "feature": "LIVENESS",
      "status": "Approved"
    },
    {
      "feature": "FACE_MATCH",
      "status": "Approved"
    },
    {
      "feature": "AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2025-06-15T10:30:00Z",
  "last_activity_at": "2025-06-15T10:30:00Z",
  "first_session_at": "2025-06-01T08:00:00Z",
  "tags": [
    {
      "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "tag": {
        "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
        "name": "VIP",
        "color": "#2567FF",
        "description": null,
        "source": "custom",
        "created_at": "2025-05-01T09:00:00Z",
        "updated_at": "2025-05-01T09:00:00Z"
      },
      "added_by_email": "analyst@acme.com",
      "added_by_name": "Jane Analyst",
      "created_at": "2025-06-02T11:00:00Z"
    }
  ],
  "comments": [
    {
      "uuid": "c1111111-2222-4333-8444-555555555555",
      "comment_type": "STATUS_CHANGED",
      "comment": "Chargeback fraud pattern confirmed",
      "actor_email": null,
      "actor_name": null,
      "previous_status": "ACTIVE",
      "new_status": "BLOCKED",
      "previous_value": null,
      "new_value": null,
      "changed_fields": [],
      "metadata": null,
      "mentioned_emails": [],
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

उपयोगकर्ता

उपयोगकर्ता स्थिति अपडेट API: ब्लॉक या फ़्लैग करें

Didit वेंडर उपयोगकर्ता को ब्लॉक, फ़्लैग या सक्रिय करें। स्थिति आगामी KYC सत्रों और लेन-देन स्क्रीनिंग पर लागू होती है। प्रति कॉल भुगतान।

PATCH

users

{vendor_data}

update-status

curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status": "BLOCKED"}'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.users.updateStatus("user-123", {
  status: "ACTIVE",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
	Status: "ACTIVE",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
        .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->updateStatus('user-123', [
    'status' => 'ACTIVE',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
    Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
  "vendor_data": "user-abc-123",
  "display_name": null,
  "full_name": "John Michael Doe",
  "date_of_birth": "1990-05-15",
  "effective_name": "John Michael Doe",
  "status": "BLOCKED",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "portrait_image_url": "https://<media-host>/...",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": [
    "USA"
  ],
  "approved_emails": [
    "john@example.com"
  ],
  "approved_phones": [
    "+14155551234"
  ],
  "features": {
    "ID_VERIFICATION": "Approved",
    "LIVENESS": "Approved",
    "FACE_MATCH": "Approved",
    "AML": "Approved"
  },
  "features_list": [
    {
      "feature": "ID_VERIFICATION",
      "status": "Approved"
    },
    {
      "feature": "LIVENESS",
      "status": "Approved"
    },
    {
      "feature": "FACE_MATCH",
      "status": "Approved"
    },
    {
      "feature": "AML",
      "status": "Approved"
    }
  ],
  "last_session_at": "2025-06-15T10:30:00Z",
  "last_activity_at": "2025-06-15T10:30:00Z",
  "first_session_at": "2025-06-01T08:00:00Z",
  "tags": [
    {
      "uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "tag": {
        "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
        "name": "VIP",
        "color": "#2567FF",
        "description": null,
        "source": "custom",
        "created_at": "2025-05-01T09:00:00Z",
        "updated_at": "2025-05-01T09:00:00Z"
      },
      "added_by_email": "analyst@acme.com",
      "added_by_name": "Jane Analyst",
      "created_at": "2025-06-02T11:00:00Z"
    }
  ],
  "comments": [
    {
      "uuid": "c1111111-2222-4333-8444-555555555555",
      "comment_type": "STATUS_CHANGED",
      "comment": "Chargeback fraud pattern confirmed",
      "actor_email": null,
      "actor_name": null,
      "previous_status": "ACTIVE",
      "new_status": "BLOCKED",
      "previous_value": null,
      "new_value": null,
      "changed_fields": [],
      "metadata": null,
      "mentioned_emails": [],
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

अवलोकन

उपयोगकर्ता इकाई की स्थिति ACTIVE, FLAGGED और BLOCKED के बीच बदलती है। पूरी स्टेट मशीन के लिए इकाई जीवनचक्र देखें।

इसे कब इस्तेमाल करें

धोखाधड़ी या अनुपालन उल्लंघन की पुष्टि होने के बाद उपयोगकर्ता को ब्लॉक करें।
उपयोगकर्ता को सख़्ती से ब्लॉक किए बिना, मैन्युअल समीक्षा लंबित रहने तक फ़्लैग करें।
सफल सुधार के बाद किसी उपयोगकर्ता को अनब्लॉक करें।
बाहरी संकेत आगे भेजें: उदाहरण के लिए, जब आपका अपना धोखाधड़ी इंजन किसी उपयोगकर्ता को थ्रेशोल्ड से ऊपर स्कोर करे, तो इस endpoint के ज़रिए उसे FLAGGED पर ले जाएँ।

नोट्स

मान्य मान: ACTIVE, FLAGGED, BLOCKED। अमान्य मान पर 400 लौटता है।
स्थिति बदलने का कारण दर्ज करने के लिए वैकल्पिक reason पास करें (अधिकतम 1000 अक्षर)। Didit इसे व्यक्ति की गतिविधि में स्थिति-परिवर्तन प्रविष्टि की टिप्पणी के रूप में रखता है: उपयोगकर्ता पर comments[].comment, और Business Console में गतिविधि। यह तभी दर्ज होता है जब स्थिति वास्तव में बदलती है।
BLOCKED उपयोगकर्ताओं के सभी नए सत्र और सभी नए लेन-देन स्वतः अस्वीकृत हो जाते हैं।
previous_status और status के साथ user.status.updated webhook भेजा जाता है। इस webhook में reason शामिल नहीं होता।

प्रवर्तन

स्थिति	नए सत्रों पर प्रभाव	नए लेन-देन पर प्रभाव
`ACTIVE`	सामान्य प्रवाह	सामान्य प्रवाह
`FLAGGED`	अनुमत, लेकिन `IN_REVIEW` पर भेजा जाता है	अनुमत; नियमों के आधार पर स्वतः एस्केलेट हो सकता है
`BLOCKED`	स्वतः अस्वीकृत	स्वतः अस्वीकृत

अनुमतियाँ

प्राथमिक सीक्रेट और पूर्ण-एक्सेस API कुंजियाँ इस endpoint को हमेशा कॉल कर सकती हैं। कस्टम एक्सेस वाली कुंजी को People (users) पर लिखने की अनुमति चाहिए। जो कुंजी केवल कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित है, वह इस endpoint तक नहीं पहुँच सकती। Console की भूमिकाएँ और अनुमतियाँ तय करती हैं कि कोई टीम सदस्य Console में क्या कर सकता है। API कुंजी के अनुरोधों के लिए इनका मूल्यांकन नहीं किया जाता।

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

पथ पैरामीटर

vendor_data

string

आवश्यक

उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता।

बॉडी

application/json

status

enum<string>

आवश्यक

नई लाइफ़साइकिल स्थिति। BLOCKED सिस्टम ब्लॉकलिस्ट में vendor_data भी जोड़ता है।

उपलब्ध विकल्प:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

स्थिति क्यों बदली। उपयोगकर्ता की गतिविधि की स्थिति-परिवर्तन प्रविष्टि (comments[].comment, और Business Console में Activity) पर रिकॉर्ड किया जाता है, केवल तभी जब स्थिति वास्तव में बदलती है। Webhooks इसे शामिल नहीं करते हैं।

Maximum string length: 1000

प्रतिक्रिया

उपयोगकर्ता स्थिति अपडेट की गई। पूरा उपयोगकर्ता रिकॉर्ड लौटाया गया।

पूर्ण उपयोगकर्ता विवरण। मेटाडेटा, टिप्पणियों और updated_at के साथ UserListItem का विस्तार करता है।

didit_internal_id

string<uuid>

इस उपयोगकर्ता के लिए Didit का स्थायी आंतरिक UUID।

vendor_data

string | null

इस उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (सत्र बनाते समय पास किया गया)। जब कोई वेंडर पहचानकर्ता प्रदान नहीं किया गया था, तो यह null हो सकता है।

display_name

string | null

आपके द्वारा सेट किया गया कस्टम प्रदर्शन नाम

full_name

string | null

सत्यापित दस्तावेज़ों से निकाला गया पूरा नाम

date_of_birth

string<date> | null

effective_name

string | null

सर्वोत्तम उपलब्ध नाम: यदि सेट है तो display_name, अन्यथा full_name

status

enum<string>

उपयोगकर्ता रिकॉर्ड की लाइफ़साइकिल स्थिति (सत्र स्थिति नहीं)। ACTIVE डिफ़ॉल्ट है, FLAGGED उपयोगकर्ता को मैन्युअल ध्यान के लिए चिह्नित करता है, BLOCKED इस vendor_data के लिए नए सत्रों को रोकता है।

उपलब्ध विकल्प:

ACTIVE,

FLAGGED,

BLOCKED

portrait_image_url

string | null

उपयोगकर्ता की पोर्ट्रेट फ़ोटो का प्री-साइन किया गया URL (कुछ घंटों के बाद समाप्त हो जाता है)

session_count

integer

इस उपयोगकर्ता के लिए सत्यापन सत्रों की कुल संख्या

approved_count

integer

स्वीकृत सत्रों की संख्या

declined_count

integer

अस्वीकृत सत्रों की संख्या

in_review_count

integer

समीक्षाधीन सत्रों की संख्या

issuing_states

string[]

इस उपयोगकर्ता के स्वीकृत ID दस्तावेज़ों पर देखे गए जारीकर्ता देशों के ISO 3166-1 alpha-3 कोड, उदा. ["USA", "ESP"]। कोई न होने पर खाली ऐरे।

approved_emails

string[]

इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित ईमेल पते, उदा. ["john@example.com"]।

approved_phones

string[]

इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित फ़ोन नंबर, उदा. ["+14155551234"]।

features

object

इस उपयोगकर्ता के सभी सत्रों में प्रति-सुविधा एकत्रित स्थिति। संभावित कुंजियाँ: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION। संभावित मान: Approved, Declined, In Review, Not Finished, Resub Requested।

features_list

object[]

features जैसा ही डेटा, {feature, status} ऑब्जेक्ट्स के एक क्रमबद्ध ऐरे के रूप में।

Show child attributes

last_session_at

string<date-time> | null

सबसे हाल के सत्र का टाइमस्टैम्प

first_session_at

string<date-time> | null

पहले सत्र का टाइमस्टैम्प

last_activity_at

string<date-time> | null

इस उपयोगकर्ता की सबसे हाल की गतिविधि का टाइमस्टैम्प (सत्र, लेन-देन, स्थिति परिवर्तन, डेटा संपादन, आदि)।

​अवलोकन

​इसे कब इस्तेमाल करें

​नोट्स

​प्रवर्तन

​अनुमतियाँ

​संबंधित

प्राधिकरण

पथ पैरामीटर

बॉडी

प्रतिक्रिया

अवलोकन

इसे कब इस्तेमाल करें

नोट्स

प्रवर्तन

अनुमतियाँ

संबंधित