> ## 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. # Benutzer anlegen API: Vendor-User-Entität > Didit-Vendor-User vorab anlegen, bevor KYC-Sitzungen starten. Für Massen-Onboarding aus Fremddatenbanken oder Transaktionsüberwachung. Prompt: Benutzer anlegen Prompt in die Zwischenablage kopieren \

\`Goal: Pre-create a Didit User entity by vendor_data before any verification session runs, and optionally email the person a verification link in the same call.

Endpoint: POST https://verification.didit.me/v3/users/create/
Auth header: x-api-key: 
Content-Type: application/json

Request body fields:
\- vendor_data (string, REQUIRED) — your unique identifier for this user. Free-form string, NOT a UUID. Must be unique among non-deleted users in the app. Normalised lowercase + whitespace trim, so "USER-1" and "user-1" collide. Max 2000 bytes (UTF-8 encoded); longer values return a 400.
\- full_name (string, max 512, optional)
\- display_name (string, optional) — friendly label for the Console (takes precedence over full_name for UI).
\- date_of_birth (string YYYY-MM-DD, optional)
\- status (enum, optional) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Defaults to "ACTIVE".
\- metadata (object, optional) — arbitrary JSON you attach to the user.
\- approved_emails (object, optional) — e.g. {"john@example.com": true}.
\- approved_phones (object, optional).
\- issuing_states (object, optional) — e.g. {"USA": 1}.

Contact fields (all optional):
\- first_name, last_name (string, max 255 each): joined with a space into full_name when you don't send full_name.
\- email (string, email): stored in metadata.contact.email.
\- phone_number (string, max 32): stored in metadata.contact.phone_number.
\- country (string): ISO 3166 code, alpha-2 or alpha-3 ("ES" or "ESP"), stored uppercased in metadata.address.country.

Verification link (optional):
\- send_verification_link (boolean, default false): when true, Didit also creates a verification session for the person on workflow_id and emails them the link at email.
\- workflow_id (UUID): REQUIRED with send_verification_link. The workflow must verify a person: a Business Verification (KYB) workflow is refused.
\- language (string, max 10): language of the verification email, a supported language code. English when omitted.
\- The person and the session are created together or not at all. The session runs the same checks as POST /v3/session/ (blocklist, credits).

curl:
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'

curl with a verification link:
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "YOUR_WORKFLOW_ID"}'

Response 201: full UserDetailItem (same shape as GET /v3/users/{vendor_data}/) plus verification_link. Includes didit_internal_id (UUID), session_count, approved_count=0, metadata, comments=[], created_at, updated_at. See /reference/data-models.
\- verification_link is always present: null without a link, otherwise { session_id, session_number, status, url, workflow_id, email }. url is the link Didit emailed.

Failure modes:
\- 400: nothing is written. Most errors are keyed by field. Common cases:
\{ "vendor_data": ["A user with this vendor_data already exists."] }  // conflict, NOT idempotent. Use PATCH /v3/users/{vendor_data}/ to update.
\{ "vendor_data": ["This field is required."] }
\{ "vendor_data": ["Ensure this field has no more than 2000 characters."] }  // oversized vendor_data, rejected before it reaches storage
\{ "metadata": ["Metadata must be a JSON object."] }
\{ "country": ["Use an ISO 3166 country code, like ES or ESP."] }
\{ "email": ["metadata.contact must be a JSON object to store this value."] }  // same on phone_number; metadata.address on country
\{ "email": ["An email address is required to send a verification link."] }
\{ "workflow_id": ["Pick the workflow to send a verification link for."] }
\{ "workflow_id": ["Invalid workflow_id."] }
\{ "workflow_id": ["This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link."] }
\{ "contact_details": { "email_lang": ["Invalid email language. Supported languages are ..."] } }  // unsupported language
\{ "vendor_data": "This user or business has been blocked and cannot create new verification sessions." }
\{ "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" }
\- 401: missing or 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 key without users write. { "detail": "This API key has no write access to people." }
\- 403: send_verification_link with a scoped key that lacks sessions write. Nothing is written. { "detail": "This API key has no write access to sessions." }
\- 429: rate-limited.

Upsert pattern (this endpoint is NOT idempotent):
GET /v3/users/{vendor_data}/  → on 404, POST /v3/users/create/; on 200, PATCH /v3/users/{vendor_data}/.

Notes:
\- Verified-session-derived identity fields such as full_name and date_of_birth seeded here can be overwritten by the first approved User Verification (KYC) session.
\- If you are migrating from another provider and already have a trusted face image, create the User first, read didit_internal_id from this response, then call POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/.
\- The create itself sends no webhook. Later changes to the user send user.data.updated or user.status.updated. With send_verification_link, the new session updates the user (session_count) in the same call, which sends user.data.updated.
\- API key access: a scoped key needs users write; with send_verification_link it also needs sessions write. Full-access keys can always call it.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Einfügen in ## ÜberblickLegt eine [Benutzer-Entität](https://docs.didit.me/de/entities/users/overview.md) explizit an, bevor eine Sitzung gestartet wird. Die zurückgegebene Entität erhält den Status `ACTIVE`, sofern Sie nichts anderes angeben. Optional sendet derselbe Aufruf der Person per E-Mail einen Verifizierungslink (siehe [Verifizierungslink senden](#verifizierungslink-senden)).## Wann Sie es verwenden- **Metadaten vorab befüllen** (Stufe, Registrierungsquelle, interne Tags), bevor sich der Kunde verifiziert. - **Von einem anderen Anbieter migrieren**: Bestehende Benutzerliste in Didit neu anlegen, damit Verlauf und Analysen von einer bekannten Basis aus starten. - **Vertrauenswürdige Gesichter für Profile importieren**: Zuerst den Benutzer anlegen, dann [Gesicht eines Benutzers hochladen](https://docs.didit.me/de/management-api/users/upload-face.md) mit der zurückgegebenen `didit_internal_id` aufrufen. - **Reine Transaktionsfälle**: Einen Benutzer mit `vendor_data` registrieren, damit Sie Transaktionen einreichen können, ohne jemals eine Sitzung zur Benutzerverifizierung (KYC) durchzuführen. - **Zur Verifizierung einladen**: Person anlegen und ihr in einem Aufruf einen Verifizierungslink per E-Mail senden.## KontaktdatenSie können die Kontaktdaten der Person zusammen mit den Profilfeldern senden. `first_name` und `last_name` werden mit einem Leerzeichen zu `full_name` verbunden, wenn Sie kein `full_name` senden. `email` und `phone_number` werden in `metadata.contact` gespeichert, `country` in `metadata.address`. `country` akzeptiert einen ISO-3166-Code, alpha-2 oder alpha-3 (`ES` oder `ESP`), und wird in Großbuchstaben gespeichert.Wenn die `metadata`, die Sie senden, bereits einen `contact`- oder `address`-Wert enthält, der kein JSON-Objekt ist, überschreibt Didit ihn nicht: Der Aufruf antwortet mit `400` für das Kontaktfeld, das einen JSON-Objektwert benötigt.## Verifizierungslink sendenSetzen Sie `send_verification_link` auf `true`, um die Person im selben Aufruf zur Verifizierung einzuladen. Didit erstellt für die Person eine Verifizierungssitzung im durch `workflow_id` angegebenen Workflow und sendet ihr den Link an `email`. Verwenden Sie `language`, um die [Sprache](https://docs.didit.me/de/integration/supported-languages.md) der E-Mail festzulegen; ohne Angabe ist sie Englisch.```bash theme={null} curl -X POST https://verification.didit.me/v3/users/create/ \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "YOUR_WORKFLOW_ID", "language": "es" }' ```- `email` und `workflow_id` sind bei einem Link erforderlich, und der Workflow muss eine Person verifizieren: Ein Workflow für Unternehmensverifizierung (KYB) antwortet mit `400`. - Die Sitzung durchläuft dieselben Prüfungen wie [Sitzung erstellen](https://docs.didit.me/de/sessions-api/create-session.md). Ein `vendor_data` auf der Sperrliste oder zu wenige Credits führen zu `400`. - Die Person und die Sitzung werden gemeinsam oder gar nicht angelegt. Schlägt eine Prüfung fehl, wird nichts geschrieben und keine E-Mail gesendet. - Die Antwort enthält `verification_link` mit `session_id`, `session_number`, `status`, `url` und `workflow_id` der Sitzung sowie der `email`, an die er gesendet wurde. Ohne Link ist `verification_link` `null`.## Hinweise- `vendor_data` ist Pflicht und muss je Anwendung eindeutig sein. Der Versuch, ein Duplikat anzulegen, gibt einen Konfliktfehler zurück. Verwenden Sie [`PATCH /v3/users/{vendor_data}/`](https://docs.didit.me/de/management-api/users/update), um einen bestehenden Benutzer zu aktualisieren. - `vendor_data` hat ein festes Limit von 2000 Bytes (UTF-8-kodiert). Ein Wert, der dieses Limit überschreitet, führt zu einem Validierungsfehler mit 400, statt akzeptiert zu werden. - Felder, die normalerweise aus verifizierten Sitzungen abgeleitet werden (`full_name`, `date_of_birth`), können hier vorbelegt werden, können aber durch die erste genehmigte Sitzung zur Benutzerverifizierung (KYC) **überschrieben** werden. - Gesichtsbilder werden von diesem Endpoint nicht akzeptiert. Um ein vertrauenswürdiges importiertes Gesicht anzuhängen, verwenden Sie [`POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/`](https://docs.didit.me/de/management-api/users/upload-face), nachdem dieser Endpoint die `didit_internal_id` zurückgegeben hat. - Das Anlegen selbst sendet keinen Webhook. Spätere Änderungen am Benutzer senden `user.data.updated` oder `user.status.updated`. - Mit `send_verification_link` aktualisiert die neue Sitzung den Benutzer im selben Aufruf, was `user.data.updated` sendet.## BerechtigungenDas primäre Secret und [API-Schlüssel](https://docs.didit.me/de/console/api-keys.md) mit vollem Zugriff können diesen Endpoint immer aufrufen. Ein Schlüssel mit benutzerdefiniertem Zugriff benötigt Schreibzugriff auf **Personen** (`users`). Mit `send_verification_link: true` benötigt er außerdem Schreibzugriff auf **Sitzungen**, weil der Aufruf eine Sitzung erstellt und deren Link ausgibt. Ohne diesen Zugriff antwortet der Aufruf mit `403` und `This API key has no write access to sessions.`, und nichts wird geschrieben. Ein Schlüssel, der auf bestimmte Workflows oder auf genehmigte Sitzungen beschränkt ist, kann diesen Endpoint nicht erreichen.Die [Rollen und Berechtigungen](https://docs.didit.me/de/console/roles-permissions.md) der Konsole bestimmen, was ein Teammitglied in der Konsole tun darf. Sie werden für Anfragen mit API-Schlüsseln nicht ausgewertet.## Verwandte Seiten- [Datenmodell für Benutzer](https://docs.didit.me/de/entities/users/data-model.md) - [Gesicht eines Benutzers hochladen](https://docs.didit.me/de/management-api/users/upload-face.md) - [Verknüpfung von Vendor-Daten](https://docs.didit.me/de/entities/vendor-data-linking.md) - [Benutzeroperationen](https://docs.didit.me/de/entities/users/operations.md) ## OpenAPI ````yaml de/openapi-25.json POST /v3/users/create/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/users/create/: post: tags: - Users summary: Benutzer erstellen description: >- Erstellen Sie einen [Benutzer](/entities/users) anhand von `vendor_data`, vor oder ohne eine Verifizierungssitzung. `vendor_data` muss unter den Benutzern der Anwendung eindeutig sein (ein Duplikat gibt `400` zurück). Nicht idempotent. **Kontaktdaten:** `email` und `phone_number` werden in `metadata.contact` gespeichert und `country` in `metadata.address`. Wenn Sie `first_name` oder `last_name` ohne `full_name` übermitteln, führt Didit diese zu `full_name` zusammen. **Verifizierungslink:** Bei `send_verification_link: true` erstellt Didit außerdem eine Verifizierungssitzung für die Person mit `workflow_id` und sendet ihr den Link per E-Mail an `email`. Die Sitzung führt dieselben Prüfungen wie [Sitzung erstellen](/de/sessions-api/create-session) aus, wie etwa die Sperrliste und Ihr Credit-Guthaben. Die Person und die Sitzung werden entweder gemeinsam oder gar nicht erstellt: Schlägt eine Prüfung fehl, wird nichts geschrieben und keine E-Mail versendet. Das Feld `verification_link` in der Antwort beschreibt die Sitzung und ist `null`, wenn Sie keinen Link anfordern. **API-Schlüssel-Zugriff:** Ein Scoped-API-Schlüssel benötigt die Schreibberechtigung für `users`. Bei `send_verification_link: true` benötigt er zudem die Schreibberechtigung für `sessions`, andernfalls antwortet der Aufruf mit `403`, bevor etwas geschrieben wird. Schlüssel mit Vollzugriff sind davon nicht betroffen. Siehe [API-Schlüssel](/de/console/api-keys). operationId: create_user requestBody: required: true content: application/json: schema: type: object required: - vendor_data properties: vendor_data: type: string description: >- Ihre eindeutige Kennung für diesen Benutzer (Freitext-String, KEINE UUID). Muss unter den Benutzern der Anwendung eindeutig sein; exakt wie übermittelt abgeglichen. full_name: type: string nullable: true maxLength: 512 description: Vollständiger rechtlicher Name des Benutzers. display_name: type: string nullable: true description: >- Benutzerfreundlicher Anzeigename, der in der Konsole angezeigt wird (hat für die UI-Anzeige Vorrang vor `full_name`). maxLength: 255 date_of_birth: type: string format: date nullable: true description: Geburtsdatum im Format `YYYY-MM-DD`. status: type: string enum: - ACTIVE - FLAGGED - BLOCKED default: ACTIVE description: Anfänglicher Lebenszyklusstatus. Standardmäßig `ACTIVE`. metadata: type: object nullable: true description: >- Beliebiges JSON-Objekt, das Sie an den Benutzer anhängen. Standardmäßig `{}`. approved_emails: type: array items: type: string description: >- Vorab als vertrauenswürdig eingestufte E-Mail-Adressen für diesen Benutzer, z. B. `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Vorab als vertrauenswürdig eingestufte Telefonnummern für diesen Benutzer, z. B. `["+14155551234"]`. issuing_states: type: array items: type: string description: >- Vorab erfasste Ausstellungsländer (ISO 3166-1 Alpha-3), z. B. `["USA"]`. first_name: type: string maxLength: 255 description: >- Vorname. Wenn `full_name` nicht gesendet wird, verbindet Didit `first_name` und `last_name` mit einem Leerzeichen zu `full_name`. Wird nicht als separates Feld zurückgegeben. last_name: type: string maxLength: 255 description: >- Nachname. Wird mit `first_name` zu `full_name` zusammengefügt, wenn `full_name` nicht übermittelt wird. Wird nicht als separates Feld zurückgegeben. email: type: string format: email description: >- Kontakt-E-Mail, gespeichert in `metadata.contact.email` (sie ersetzt eine `email`, die Sie innerhalb von `metadata.contact` senden). Erforderlich, wenn `send_verification_link` auf `true` gesetzt ist: Der Link wird an diese Adresse gesendet. Wenn `metadata.contact` kein JSON-Objekt ist, antwortet der Aufruf bei diesem Feld mit `400`. phone_number: type: string maxLength: 32 description: >- Telefonnummer des Kontakts, gespeichert in `metadata.contact.phone_number`. Wenn `metadata.contact` kein JSON-Objekt ist, antwortet der Aufruf für dieses Feld mit `400`. country: type: string maxLength: 3 description: >- Land als ISO-3166-Code, Alpha-2 oder Alpha-3 (`ES` oder `ESP`). Wird in Großbuchstaben in `metadata.address.country` gespeichert. Wenn `metadata.address` kein JSON-Objekt ist, antwortet der Aufruf für dieses Feld mit `400`. send_verification_link: type: boolean default: false description: >- Wenn `true`, erstellt Didit eine Verifizierungssitzung für die Person unter `workflow_id` und sendet ihr den Link per E-Mail an `email`. Erfordert `email` und `workflow_id`. Ein berechtigungsbeschränkter API-Schlüssel benötigt außerdem Schreibrechte für `sessions`. workflow_id: type: string format: uuid description: >- Der Workflow der Verifizierungssitzung. Erforderlich, wenn `send_verification_link` auf `true` gesetzt ist. Er muss eine Person verifizieren: Ein Workflow für Unternehmensverifizierung (KYB) wird abgelehnt. Andernfalls wird er ignoriert. language: type: string maxLength: 10 description: >- Sprache der Verifizierungs-E-Mail als Code einer [unterstützten Sprache](/de/integration/supported-languages). Wenn nicht angegeben, wird Englisch verwendet. Wird ignoriert, wenn `send_verification_link` nicht `true` ist. examples: Basic: summary: Mit Basisinformationen erstellen value: vendor_data: user-abc-123 full_name: John Doe Full: summary: Alle Felder value: vendor_data: user-abc-456 full_name: Jane Smith display_name: Jane S. date_of_birth: '1990-05-15' status: ACTIVE metadata: tier: premium source: api approved_emails: - jane@example.com Contact details: summary: Name, E-Mail, Telefon und Land value: vendor_data: user-abc-789 first_name: Julia last_name: Martin email: julia.martin@example.com phone_number: '+34600000000' country: ES With verification link: summary: >- Person erstellen und ihr einen Verifizierungslink per E-Mail senden value: vendor_data: user-abc-789 first_name: Julia last_name: Martin email: julia.martin@example.com send_verification_link: true workflow_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 language: es responses: '201': description: >- Benutzer erstellt. Der vollständige Benutzerdatensatz (gleiches Format wie bei Get User), plus `verification_link`: die Verifizierungssitzung, die Didit per E-Mail gesendet hat, wenn `send_verification_link` auf `true` gesetzt war, andernfalls `null`. content: application/json: schema: allOf: - $ref: '#/components/schemas/UserDetailItem' - type: object required: - verification_link properties: verification_link: type: object nullable: true description: >- Die Verifizierungssitzung, die Didit erstellt und der Person per E-Mail gesendet hat. Immer vorhanden: `null`, wenn `send_verification_link` nicht `true` war. required: - session_id - session_number - status - url - workflow_id - email properties: session_id: type: string format: uuid description: ID der Verifizierungssitzung. session_number: type: integer description: >- Fortlaufende Nummer der Sitzung innerhalb Ihrer Anwendung. status: type: string description: >- Status der Sitzung, `Not Started` für eine Sitzung, die gerade erst erstellt wurde. url: type: string format: uri description: >- Der Verifizierungslink, den Didit der Person per E-Mail gesendet hat. workflow_id: type: string format: uuid nullable: true description: Der Workflow, den die Sitzung ausführt. email: type: string format: email description: Die Adresse, an die der Link gesendet wurde. examples: Created: value: didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: null full_name: John Doe date_of_birth: null effective_name: John Doe status: ACTIVE metadata: {} portrait_image_url: null session_count: 0 approved_count: 0 declined_count: 0 in_review_count: 0 issuing_states: [] approved_emails: [] approved_phones: [] features: {} features_list: [] last_session_at: null last_activity_at: '2025-06-15T10:30:00Z' first_session_at: null tags: [] comments: [] created_at: '2025-06-15T10:30:00Z' updated_at: '2025-06-15T10:30:00Z' verification_link: null Created with verification link: value: didit_internal_id: 9b2f6c1e-3d4a-4e5f-8a7b-1c2d3e4f5a6b vendor_data: user-abc-789 display_name: null full_name: Julia Martin date_of_birth: null effective_name: Julia Martin status: ACTIVE metadata: contact: email: julia.martin@example.com portrait_image_url: null session_count: 1 approved_count: 0 declined_count: 0 in_review_count: 0 issuing_states: [] approved_emails: [] approved_phones: [] features: {} features_list: [] last_session_at: '2025-06-15T10:30:00Z' last_activity_at: '2025-06-15T10:30:00Z' first_session_at: '2025-06-15T10:30:00Z' tags: [] comments: [] created_at: '2025-06-15T10:30:00Z' updated_at: '2025-06-15T10:30:00Z' verification_link: session_id: 3fa85f64-5717-4562-b3fc-2c963f66afa7 session_number: 43762 status: Not Started url: https://verify.didit.me/en/session/3FaJ9wLqX2Mz workflow_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 email: julia.martin@example.com '400': description: >- Ungültiger Body, nach Feldern aufgeschlüsselt: typischerweise ein dupliziertes `vendor_data`, ein fehlendes Pflichtfeld oder ein fehlerhafter Wert. Bei `send_verification_link: true` auch eine fehlende `email` oder `workflow_id`, ein unbekannter Workflow oder ein Workflow für die Unternehmensverifizierung (KYB), eine nicht unterstützte `language` (mit Schlüssel `contact_details.email_lang`), ein auf der Sperrliste stehendes `vendor_data` oder zu wenige Credits zum Starten der Sitzung. Es wird nichts geschrieben. content: application/json: examples: Duplicate: value: vendor_data: - A user with this vendor_data already exists. Missing vendor_data: value: vendor_data: - This field is required. Bad metadata: value: metadata: - Metadata must be a JSON object. Bad status: value: status: - >- Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED Bad country: value: country: - Use an ISO 3166 country code, like ES or ESP. Contact not an object: value: email: - >- metadata.contact must be a JSON object to store this value. Address not an object: value: country: - >- metadata.address must be a JSON object to store this value. Link without email or workflow: value: email: - >- An email address is required to send a verification link. workflow_id: - Pick the workflow to send a verification link for. Unknown workflow: value: workflow_id: - Invalid workflow_id. Business workflow: value: workflow_id: - >- This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link. Blocklisted vendor_data: value: vendor_data: >- This user or business has been blocked and cannot create new verification sessions. Insufficient credits: value: detail: >- You don't have enough credits to perform this request. Please top up at https://business.didit.me '401': description: >- Keine Anmeldedaten angegeben. Anfragen an `/v3/users/*`-Pfade ohne einen `x-api-key`-Header (oder `Authorization: Bearer`-Token) werden von der Authentifizierungs-Middleware abgelehnt, bevor sie die API erreichen. content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- Ungültiger oder widerrufener API-Schlüssel, oder der Schlüssel kann keine Benutzer für diese Anwendung erstellen. Ein berechtigungsbeschränkter API-Schlüssel benötigt Schreibzugriff auf `users` und zusätzlich Schreibzugriff auf `sessions`, wenn `send_verification_link` auf `true` gesetzt ist; es wird nichts geschrieben. Ein fehlender Schlüssel gibt `403` zurück; ein falscher, widerrufener oder abgelaufener Schlüssel gibt `401` zurück. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. No sessions write: summary: >- Schlüssel mit eingeschränktem Berechtigungsumfang fordert einen Verifizierungslink ohne sessions write an value: detail: This API key has no write access to sessions. '429': description: >- Rate-Limit überschritten; drosseln Sie die Anfragen und wiederholen Sie den Versuch nach dem in `Retry-After` angegebenen Intervall. 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 POST 'https://verification.didit.me/v3/users/create/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.create( vendor_data="user-abc-123", full_name="John Doe", ) 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.create({ vendor_data: "user-abc-123", full_name: "John Doe", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Create(ctx, didit.UsersCreateParams{\n\tVendorData: \"user-abc-123\",\n\tFullName: didit.String(\"John Doe\"),\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.UsersCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().create(UsersCreateParams.builder() .vendorData("user-abc-123") .fullName("John Doe") .build()); System.out.println(result); - lang: php label: PHP source: |- users->create([ 'vendor_data' => 'user-abc-123', 'full_name' => 'John Doe', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.create( vendor_data: "user-abc-123", full_name: "John Doe" ) 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.CreateAsync(new UsersCreateParams { VendorData = "user-abc-123", FullName = "John Doe", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: UserDetailItem: type: object description: >- Vollständige Benutzerdetails. Erweitert UserListItem um Metadaten, Kommentare und updated_at. allOf: - $ref: '#/components/schemas/UserListItem' - type: object properties: metadata: type: object description: >- Benutzerdefiniertes Metadaten-JSON, das Sie diesem Benutzer angehängt haben. Standardmäßig `{}`. tags: type: array description: >- Tag-Zuweisungen. HINWEIS: Bei Detailantworten ist jeder Eintrag ein Tag-*Link*-Objekt (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), anders als die flache Struktur `{uuid, name, color}`, die bei Listenantworten verwendet wird. items: type: object properties: uuid: type: string format: uuid description: UUID der Tag-Zuweisung (nicht des Tags selbst). 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: Vorherige Feldwerte für PROFILE_UPDATED-Einträge. new_value: type: object nullable: true description: Neue Feldwerte für PROFILE_UPDATED-Einträge. changed_fields: type: array items: type: string description: >- Namen der Felder, die durch einen PROFILE_UPDATED-Eintrag geändert wurden. metadata: type: object nullable: true mentioned_emails: type: array items: type: string created_at: type: string format: date-time description: >- Aktivitätsprotokoll und Kommentare für diesen Benutzer (Statusänderungen, Profilbearbeitungen, manuelle Notizen). updated_at: type: string format: date-time UserListItem: type: object description: Ein verifizierter Benutzer. properties: didit_internal_id: type: string format: uuid description: Didits stabile interne UUID für diesen Benutzer. vendor_data: type: string nullable: true description: >- Ihre eindeutige Kennung für diesen Benutzer (beim Erstellen von Sitzungen übergeben). Dies kann null sein, wenn keine Vendor-Kennung angegeben wurde. display_name: type: string nullable: true description: Von Ihnen festgelegter benutzerdefinierter Anzeigename full_name: type: string nullable: true description: Aus verifizierten Dokumenten extrahierter vollständiger Name date_of_birth: type: string format: date nullable: true effective_name: type: string nullable: true description: >- Bester verfügbarer Name: display_name, falls gesetzt, andernfalls full_name status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- Lebenszyklusstatus des Benutzerdatensatzes (KEIN Sitzungsstatus). `ACTIVE` ist der Standard, `FLAGGED` markiert den Benutzer für manuelle Prüfung, `BLOCKED` verhindert neue Sitzungen für dieses `vendor_data`. portrait_image_url: type: string nullable: true description: >- Vorsignierte URL des Porträtfotos des Benutzers (läuft nach wenigen Stunden ab) session_count: type: integer description: Gesamtzahl der Verifizierungssitzungen für diesen Benutzer approved_count: type: integer description: Anzahl der genehmigten Sitzungen declined_count: type: integer description: Anzahl der abgelehnten Sitzungen in_review_count: type: integer description: Anzahl der Sitzungen in Prüfung issuing_states: type: array items: type: string description: >- ISO 3166-1-Alpha-3-Codes der Ausstellungsländer, die auf den genehmigten Ausweisdokumenten dieses Benutzers gefunden wurden, z. B. `["USA", "ESP"]`. Leeres Array, wenn keine vorhanden sind. approved_emails: type: array items: type: string description: >- Verifizierte E-Mail-Adressen, die aus den genehmigten Sitzungen dieses Benutzers erfasst wurden, z. B. `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Verifizierte Telefonnummern, die aus den genehmigten Sitzungen dieses Benutzers erfasst wurden, z. B. `["+14155551234"]`. features: type: object description: >- Aggregierter Status pro Funktion über alle Sitzungen dieses Benutzers hinweg. Mögliche Schlüssel: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Mögliche Werte: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`. features_list: type: array items: type: object properties: feature: type: string status: type: string description: >- Dieselben Daten wie `features`, als geordnetes Array von `{feature, status}`-Objekten. last_session_at: type: string format: date-time nullable: true description: Zeitstempel der letzten Sitzung first_session_at: type: string format: date-time nullable: true description: Zeitstempel der ersten Sitzung last_activity_at: type: string format: date-time nullable: true description: >- Zeitstempel der letzten Aktivität bei diesem Benutzer (Sitzung, Transaktion, Statusänderung, Datenbearbeitung usw.). tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Diesem Benutzer zugewiesene Tags created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.