> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# उपयोगकर्ता अपडेट करें API: Vendor User Entity
> Didit के वेंडर उपयोगकर्ता के बदलने योग्य फ़ील्ड अपडेट करें: प्रदर्शन नाम, मेटाडेटा, टैग। सत्यापित पहचान फ़ील्ड अपरिवर्तनीय हैं। प्रति कॉल भुगतान।
उपयोगकर्ता अपडेट प्रॉम्प्ट
प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें
\
\`Goal: Partial-update a Didit User entity by vendor_data.
Endpoint: PATCH https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key:
Content-Type: application/json
Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.
Request body (PARTIAL — only included fields are touched; auto-derived counters and session history are left alone):
\- full_name (string, max 512, nullable)
\- display_name (string, nullable)
\- date_of_birth (string YYYY-MM-DD, nullable)
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Setting "BLOCKED" auto-adds vendor_data to the system blocklist; flipping away removes it.
\- metadata (object, nullable) — REPLACES existing metadata wholesale; merge client-side if you only want to add keys.
\- approved_emails (object)
\- approved_phones (object)
\- issuing_states (object)
\- reason (string, optional, max 1000): why the status changed. Recorded as the comment of the STATUS_CHANGED entry in the user's activity (comments[].comment), only when this update actually changes status. Webhooks do not carry it.
curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Jane S.", "status": "FLAGGED", "reason": "Address does not match the billing country"}'
Response 200: full updated UserDetailItem (same shape as GET). See /reference/data-models.
Side effects:
\- Writes to the user's comments activity log (actor derived from the API key): a STATUS_CHANGED entry with reason when status changes, and a PROFILE_UPDATED entry when display_name, full_name, date_of_birth or metadata change.
\- last_activity_at bumped to now().
\- Concurrent updates: last-write-wins per field.
\- Re-sending an unchanged body is safe (no extra audit row).
Failure modes:
\- 400 — validation. Examples:
\{ "status": ["Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED"] }
\{ "metadata": ["Metadata must be a JSON object."] }
date_of_birth must be YYYY-MM-DD.
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key. { "detail": "Authentication credentials were not provided." }
\- 403 — the API key is revoked or is not valid for this application. { "detail": "You do not have permission to perform this action." }
\- 403: a scoped API key without users write. { "detail": "This API key has no write access to people." }
\- 404 — vendor_data not found. { "detail": "Not found." }
\- 429 — rate-limited.
Notes:
\- vendor_data in the URL itself cannot be changed via this endpoint — create new + delete old to rekey.
\- For status-only flips, prefer the dedicated PATCH /v3/users/{vendor_data}/update-status/.
\- Overriding fields populated by a verified session is allowed but flagged in the audit log.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
यहाँ पेस्ट करें
## अवलोकन[उपयोगकर्ता इकाई](https://docs.didit.me/hi/entities/users/overview.md) के परिवर्तनीय फ़ील्ड अपडेट करता है। उपयोगकर्ता सत्यापन (KYC) सत्रों से प्रसारित होने वाले फ़ील्ड (`full_name`, `date_of_birth`, `portrait_image`, कुल काउंटर, `features`) केवल-पठन हैं।## इसका उपयोग कब करें- **अपना मेटाडेटा अपडेट करें**: उपयोगकर्ता को किसी दूसरे स्तर में ले जाएँ, टैग बदलें, या आंतरिक नोट दर्ज करें।
- **नाम बदलें**: आंतरिक-उपयोग वाले कंसोल दृश्यों के लिए बेहतर `display_name` सेट करें।
- **सत्यापित डेटा को ओवरराइड करें** (सावधानी से): मैन्युअल ओवरराइड की अनुमति है, लेकिन वे ऑडिट ट्रेल में दर्ज होते हैं।## नोट्स- इस endpoint से URL में दिया गया `vendor_data` नहीं बदला जा सकता। यदि आपको कुंजी बदलनी है, तो नया उपयोगकर्ता बनाएँ और पुराना हटा दें।
- `changed_fields` ऐरे के साथ `user.data.updated` webhook भेजा जाता है, ताकि उपभोक्ता कुशलतापूर्वक सिंक कर सकें।
- यहाँ किया गया `status` बदलाव [उपयोगकर्ता स्टेटस अपडेट करें](https://docs.didit.me/hi/management-api/users/update-status.md) की तरह काम करता है।
यह व्यक्ति की गतिविधि में दर्ज होता है, और वैकल्पिक `reason` (अधिकतम 1000 अक्षर) इसकी टिप्पणी बनता है। `BLOCKED` स्थिति `vendor_data` को सिस्टम ब्लॉकलिस्ट में जोड़ देती है।
`user.status.updated` webhook में `reason` शामिल नहीं होता।
- यदि आप किसी ऐसे फ़ील्ड पर PATCH करते हैं जो इस समय किसी सत्यापित सत्र द्वारा प्रबंधित है, तो ओवरराइड स्वीकार कर लिया जाएगा, लेकिन उसे [ऑडिट लॉग](https://docs.didit.me/hi/console/audit-logs.md) में चिह्नित किया जाएगा।## अनुमतियाँप्राथमिक सीक्रेट और पूर्ण-एक्सेस [API कुंजियाँ](https://docs.didit.me/hi/console/api-keys.md) इस endpoint को हमेशा कॉल कर सकती हैं।
कस्टम एक्सेस वाली कुंजी को **लोग** (`users`) पर लिखने की अनुमति चाहिए।
जो कुंजी केवल कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित है, वह इस endpoint तक नहीं पहुँच सकती।कंसोल की [भूमिकाएँ और अनुमतियाँ](https://docs.didit.me/hi/console/roles-permissions.md) तय करती हैं कि कोई टीम सदस्य कंसोल में क्या कर सकता है।
API कुंजी के अनुरोधों के लिए इनका मूल्यांकन नहीं किया जाता।## संबंधित- [उपयोगकर्ता संचालन](https://docs.didit.me/hi/entities/users/operations.md)
- [डेटा मॉडल](https://docs.didit.me/hi/entities/users/data-model.md)
- [स्टेटस अपडेट करें](https://docs.didit.me/hi/management-api/users/update-status.md)
## OpenAPI
````yaml hi/openapi-25.json PATCH /v3/users/{vendor_data}/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/users/{vendor_data}/:
patch:
tags:
- Users
summary: उपयोगकर्ता अपडेट करें
description: >-
किसी उपयोगकर्ता का आंशिक अपडेट: `display_name`, `full_name`,
`date_of_birth`, `status`, `metadata`,
`approved_emails`/`approved_phones`/`issuing_states`। `metadata` पूरी
तरह से बदल जाता है। यहाँ `status` बदलना [Update User
Status](#patch-/v3/users/-vendor_data-/update-status/) की तरह काम करता
है: यह वैकल्पिक `reason` के साथ `STATUS_CHANGED` गतिविधि रिकॉर्ड करता
है, और `BLOCKED` सिस्टम ब्लॉकलिस्ट में `vendor_data` जोड़ता है
(`BLOCKED` से हटाने पर वह प्रविष्टि हट जाती है)। `display_name`,
`full_name`, `date_of_birth` या `metadata` में परिवर्तन
`PROFILE_UPDATED` गतिविधि के रूप में रिकॉर्ड किए जाते हैं।
operationId: update_user
parameters:
- name: vendor_data
in: path
required: true
schema:
type: string
description: >-
उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (मुक्त-रूप स्ट्रिंग, UUID
नहीं)।
example: user-abc-123
requestBody:
content:
application/json:
schema:
type: object
properties:
full_name:
type: string
nullable: true
maxLength: 512
description: उपयोगकर्ता का पूरा नाम
display_name:
type: string
nullable: true
description: इस उपयोगकर्ता के लिए कस्टम प्रदर्शन नाम
date_of_birth:
type: string
format: date
nullable: true
description: YYYY-MM-DD प्रारूप में जन्म तिथि
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
उपयोगकर्ता जीवनचक्र स्थिति। परिवर्तन को `STATUS_CHANGED`
गतिविधि के रूप में रिकॉर्ड किया जाता है, और `BLOCKED` सिस्टम
ब्लॉकलिस्ट में `vendor_data` जोड़ता है (`BLOCKED` से हटने पर
वह प्रविष्टि हट जाती है)।
metadata:
type: object
nullable: true
description: >-
उपयोगकर्ता से जुड़ा आपका मनमाना JSON ऑब्जेक्ट। अपडेट करने पर
मौजूदा मेटाडेटा को **पूरी तरह से बदल देता है** — यदि आप केवल
कुंजियाँ जोड़ना चाहते हैं तो क्लाइंट-साइड मर्ज करें।
approved_emails:
type: array
items:
type: string
description: >-
इस उपयोगकर्ता के लिए सत्यापित ईमेल पते, उदा.
`["john@example.com"]`। संग्रहीत सूची को पूरी तरह से बदल
देता है।
approved_phones:
type: array
items:
type: string
description: >-
इस उपयोगकर्ता के लिए सत्यापित फ़ोन नंबर। संग्रहीत सूची को
पूरी तरह से बदल देता है।
issuing_states:
type: array
items:
type: string
description: >-
जारीकर्ता देश (ISO 3166-1 alpha-3), उदाहरण के लिए `["USA"]`।
संग्रहीत सूची को पूरी तरह से बदल देता है।
reason:
type: string
nullable: true
maxLength: 1000
description: >-
स्थिति क्यों बदली। उपयोगकर्ता की गतिविधि की स्थिति-परिवर्तन
प्रविष्टि (`comments[].comment`, और Business Console में
**Activity**) पर रिकॉर्ड किया जाता है, केवल तभी जब स्थिति
वास्तव में बदलती है। Webhooks इसे शामिल नहीं करते हैं।
examples:
Rename:
summary: प्रदर्शित नाम सेट करें
value:
display_name: Jane S.
Override status:
summary: समीक्षा के लिए उपयोगकर्ता को फ़्लैग करें
value:
status: FLAGGED
Add metadata:
summary: मेटाडेटा JSON बदलें
value:
metadata:
tier: premium
risk_level: low
Fix extracted DOB:
summary: निकाले गए प्रोफ़ाइल फ़ील्ड सही करें
value:
full_name: Jane Elizabeth Smith
date_of_birth: '1985-11-22'
Flag with reason:
summary: उपयोगकर्ता को फ़्लैग करें और कारण रिकॉर्ड करें
value:
status: FLAGGED
reason: Address does not match the billing country
responses:
'200':
description: >-
उपयोगकर्ता अपडेट किया गया। पूरा अपडेट किया गया उपयोगकर्ता रिकॉर्ड
(Get User के समान प्रारूप) लौटाया जाता है।
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailItem'
examples:
Updated:
value:
didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
vendor_data: user-abc-123
display_name: Jane S.
full_name: Jane Elizabeth Smith
date_of_birth: '1985-11-22'
effective_name: Jane S.
status: FLAGGED
metadata:
tier: premium
portrait_image_url: https:///...
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: []
created_at: '2025-06-01T08:00:00Z'
updated_at: '2025-06-15T10:30:00Z'
'400':
description: >-
अमान्य body — आमतौर पर एक अज्ञात `status` या `YYYY-MM-DD` में न दी
गई `date_of_birth`।
content:
application/json:
examples:
Bad status:
value:
status:
- '"INVALID" is not a valid choice.'
Bad date_of_birth:
value:
date_of_birth:
- >-
Date has wrong format. Use one of these formats instead:
YYYY-MM-DD.
Reason too long:
value:
reason:
- Ensure this field has no more than 1000 characters.
'401':
description: >-
कोई क्रेडेंशियल प्रदान नहीं किए गए। `x-api-key` हेडर (या
`Authorization: Bearer` token) के बिना `/v3/users/*` पाथ पर आने वाले
अनुरोधों को API तक पहुँचने से पहले प्रमाणीकरण मिडलवेयर द्वारा
अस्वीकार कर दिया जाता है।
content:
application/json:
examples:
Missing credentials:
value:
detail: >-
You must be authenticated with a valid access token to
access this endpoint.
'403':
description: >-
कुंजी इस एप्लिकेशन के लिए उपयोगकर्ताओं को अपडेट नहीं कर सकती। कुंजी
अनुपलब्ध होने पर `403` रिटर्न होता है; गलत, निरस्त या समय-सीमा
समाप्त कुंजी पर `401` रिटर्न होता है।
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: >-
इस एप्लिकेशन के लिए दिए गए `vendor_data` वाला कोई उपयोगकर्ता मौजूद
नहीं है।
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: >-
रेट लिमिट पार हो गई; थोड़ा रुकें और `Retry-After` में बताए गए अंतराल
के बाद पुनः प्रयास करें।
content:
application/json:
examples:
Rate limited:
value:
detail: Request was throttled. Expected available in 30 seconds.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/'
\
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Jane S.", "status": "FLAGGED"}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.update(
"user-abc-123",
display_name="Jane S.",
)
print(result)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.update("user-abc-123", {
display_name: "Jane S.",
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Update(ctx, \"user-abc-123\", didit.UsersUpdateParams{\n\tDisplayName: didit.String(\"Jane S.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import me.didit.Didit;
import me.didit.types.UsersUpdateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().update("user-abc-123",
UsersUpdateParams.builder()
.displayName("Jane S.")
.build());
System.out.println(result);
- lang: php
label: PHP
source: |-
users->update('user-abc-123', [
'display_name' => 'Jane S.',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.update(
"user-abc-123",
display_name: "Jane S."
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.UpdateAsync("user-abc-123", new
UsersUpdateParams
{
DisplayName = "Jane S.",
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
UserDetailItem:
type: object
description: >-
पूर्ण उपयोगकर्ता विवरण। मेटाडेटा, टिप्पणियों और updated_at के साथ
UserListItem का विस्तार करता है।
allOf:
- $ref: '#/components/schemas/UserListItem'
- type: object
properties:
metadata:
type: object
description: >-
कस्टम मेटाडेटा JSON जिसे आपने इस उपयोगकर्ता से जोड़ा है।
डिफ़ॉल्ट `{}` है।
tags:
type: array
description: >-
टैग असाइनमेंट। ध्यान दें: विवरण रिस्पॉन्स पर प्रत्येक प्रविष्टि
एक टैग *लिंक* ऑब्जेक्ट (`{uuid, tag: {...}, added_by_email,
added_by_name, created_at}`) होती है, जो सूची रिस्पॉन्स पर उपयोग
किए जाने वाले फ़्लैट `{uuid, name, color}` आकार से भिन्न है।
items:
type: object
properties:
uuid:
type: string
format: uuid
description: टैग असाइनमेंट का UUID (स्वयं टैग नहीं)।
tag:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description:
type: string
nullable: true
source:
type: string
enum:
- didit
- custom
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
added_by_email:
type: string
nullable: true
added_by_name:
type: string
nullable: true
created_at:
type: string
format: date-time
comments:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
comment_type:
type: string
enum:
- COMMENT
- STATUS_CHANGED
- METADATA_UPDATED
- TAG_ADDED
- TAG_REMOVED
- PROFILE_UPDATED
comment:
type: string
nullable: true
actor_email:
type: string
nullable: true
actor_name:
type: string
nullable: true
previous_status:
type: string
nullable: true
enum:
- ACTIVE
- FLAGGED
- BLOCKED
- null
new_status:
type: string
nullable: true
enum:
- ACTIVE
- FLAGGED
- BLOCKED
- null
previous_value:
type: object
nullable: true
description: PROFILE_UPDATED प्रविष्टियों के लिए पिछले फ़ील्ड मान।
new_value:
type: object
nullable: true
description: PROFILE_UPDATED प्रविष्टियों के लिए नए फ़ील्ड मान।
changed_fields:
type: array
items:
type: string
description: PROFILE_UPDATED प्रविष्टि द्वारा बदले गए फ़ील्ड्स के नाम।
metadata:
type: object
nullable: true
mentioned_emails:
type: array
items:
type: string
created_at:
type: string
format: date-time
description: >-
इस उपयोगकर्ता के लिए गतिविधि लॉग और टिप्पणियाँ (स्थिति परिवर्तन,
प्रोफ़ाइल संपादन, मैन्युअल नोट्स)।
updated_at:
type: string
format: date-time
UserListItem:
type: object
description: एक सत्यापित उपयोगकर्ता।
properties:
didit_internal_id:
type: string
format: uuid
description: इस उपयोगकर्ता के लिए Didit का स्थायी आंतरिक UUID।
vendor_data:
type: string
nullable: true
description: >-
इस उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (सत्र बनाते समय पास
किया गया)। जब कोई वेंडर पहचानकर्ता प्रदान नहीं किया गया था, तो यह
null हो सकता है।
display_name:
type: string
nullable: true
description: आपके द्वारा सेट किया गया कस्टम प्रदर्शन नाम
full_name:
type: string
nullable: true
description: सत्यापित दस्तावेज़ों से निकाला गया पूरा नाम
date_of_birth:
type: string
format: date
nullable: true
effective_name:
type: string
nullable: true
description: 'सर्वोत्तम उपलब्ध नाम: यदि सेट है तो display_name, अन्यथा full_name'
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
उपयोगकर्ता रिकॉर्ड की लाइफ़साइकिल स्थिति (सत्र स्थिति नहीं)।
`ACTIVE` डिफ़ॉल्ट है, `FLAGGED` उपयोगकर्ता को मैन्युअल ध्यान के लिए
चिह्नित करता है, `BLOCKED` इस `vendor_data` के लिए नए सत्रों को
रोकता है।
portrait_image_url:
type: string
nullable: true
description: >-
उपयोगकर्ता की पोर्ट्रेट फ़ोटो का प्री-साइन किया गया URL (कुछ घंटों
के बाद समाप्त हो जाता है)
session_count:
type: integer
description: इस उपयोगकर्ता के लिए सत्यापन सत्रों की कुल संख्या
approved_count:
type: integer
description: स्वीकृत सत्रों की संख्या
declined_count:
type: integer
description: अस्वीकृत सत्रों की संख्या
in_review_count:
type: integer
description: समीक्षाधीन सत्रों की संख्या
issuing_states:
type: array
items:
type: string
description: >-
इस उपयोगकर्ता के स्वीकृत ID दस्तावेज़ों पर देखे गए जारीकर्ता देशों
के ISO 3166-1 alpha-3 कोड, उदा. `["USA", "ESP"]`। कोई न होने पर खाली
ऐरे।
approved_emails:
type: array
items:
type: string
description: >-
इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित ईमेल पते,
उदा. `["john@example.com"]`।
approved_phones:
type: array
items:
type: string
description: >-
इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित फ़ोन नंबर,
उदा. `["+14155551234"]`।
features:
type: object
description: >-
इस उपयोगकर्ता के सभी सत्रों में प्रति-सुविधा एकत्रित स्थिति। संभावित
कुंजियाँ: `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:
type: array
items:
type: object
properties:
feature:
type: string
status:
type: string
description: >-
`features` जैसा ही डेटा, `{feature, status}` ऑब्जेक्ट्स के एक
क्रमबद्ध ऐरे के रूप में।
last_session_at:
type: string
format: date-time
nullable: true
description: सबसे हाल के सत्र का टाइमस्टैम्प
first_session_at:
type: string
format: date-time
nullable: true
description: पहले सत्र का टाइमस्टैम्प
last_activity_at:
type: string
format: date-time
nullable: true
description: >-
इस उपयोगकर्ता की सबसे हाल की गतिविधि का टाइमस्टैम्प (सत्र, लेन-देन,
स्थिति परिवर्तन, डेटा संपादन, आदि)।
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description: इस उपयोगकर्ता को असाइन किए गए टैग
created_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
आपकी एप्लिकेशन की 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।
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.