Skip to main content
POST
Verifizierung eines Handles anlegen

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Path Parameters

handleId
string
required

Handle identifier

Body

application/json

The new HandleVerification resource

evidence
enum<string>
default:""
required
Available options:
idcard,
passport,
population_register,
residence_permit,
proof_of_arrival,
drivers_licence,
company_register,
company_statement,
bank_account,
online_payment_account,
utility_account,
bank_statement,
tax_statement,
written_attestation,
digital_attestation,
postal_ver_transaction_log,
email_ver_transaction_log,
address_database,
phone_account,
phone_verification
Example:

"idcard"

method
enum<string>
default:""
required
Available options:
auth,
electronic_document,
physical_document,
vdig,
bvr,
pvr,
data,
reachability
Example:

"electronic_document"

claims
string[]
required
Minimum array length: 1
Example:
result
enum<string>
default:""
required
Available options:
success,
failed
Example:

"success"

reference
string
default:""
required

Reference number (required)

Required string length: 1 - 255
Example:

"DE nis2_customer_note"

verificationTimestamp
string | null

Verification timestamp (ISO 8601)

Example:

"2026-02-17T14:30:00+01:00"

Response

HandleVerification resource created

id
string
read-only
evidence
enum<string>
Available options:
idcard,
passport,
population_register,
residence_permit,
proof_of_arrival,
drivers_licence,
company_register,
company_statement,
bank_account,
online_payment_account,
utility_account,
bank_statement,
tax_statement,
written_attestation,
digital_attestation,
postal_ver_transaction_log,
email_ver_transaction_log,
address_database,
phone_account,
phone_verification
method
enum<string>
Available options:
auth,
electronic_document,
physical_document,
vdig,
bvr,
pvr,
data,
reachability
claims
string[]
result
enum<string>
Available options:
success,
failed
reference
string
verificationTimestamp
string<date-time>
trustFramework
string
default:de_denic
Example:

"de_denic"

createdAt
string<date-time>
read-only