Zum Inhalt springen

Ein Vimine-Konto für eine Person anlegen (serverseitig)

POST
/v1/signup
curl --request POST \
--url https://api.vimine.network/v1/signup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com", "first_name": "example", "last_name": "example", "phone": "example", "dob": "2026-04-15", "gender": "M", "birthplace": "example", "birth_country": "example", "codicefiscale": "example", "codicefiscale_confirmed": true, "locale": "example", "accept_terms": { "version": "example", "sha256": "example" }, "acknowledge_privacy": { "version": "example", "sha256": "example" } }'

Legt die Identität an und schickt der Person die E-Mail, mit der sie die Adresse bestätigt und ein Passwort festlegt. Antwortet immer 202: Ob die Adresse schon ein Konto hatte, wird nie offengelegt (stattdessen erfährt es der Inhaber der Adresse per E-Mail). Nur Client-Tokens (identity:signup); akzeptiert Idempotency-Key.

Medientypapplication/json
object
email
erforderlich
string Format: email
first_name
erforderlich
string
<= 50 Zeichen
last_name
erforderlich
string
<= 50 Zeichen
phone
string
nullable <= 20 Zeichen
dob
string Format: date
nullable
gender

Nur statistisch: wird nicht abgeglichen

string
nullable
Erlaubte Werte: M F
birthplace

Gemeinde (in Italien geboren) oder Stadt, freier Text (im Ausland geboren)

string
nullable <= 150 Zeichen
birth_country

ISO 3166-1 alpha-2

string
nullable >= 2 Zeichen <= 2 Zeichen
codicefiscale

Wenn vorhanden, geprüft und mit den anderen Feldern abgeglichen

string
nullable <= 16 Zeichen
codicefiscale_confirmed

Die Person bestätigt eine Steuernummer, die nicht zu ihren Angaben passt (422 codicefiscale_mismatch mit confirmable: true)

boolean
locale

Die Sprache der Seite, die die Person ausgefüllt hat (eine Sprache der Plattform — it, en, …; jedes andere Tag wird einer Sprache der Plattform zugeordnet: en-GB → en, zh-TW → zh-Hant). Sie bestimmt die Sprache der folgenden E-Mails und wird zur Einstellung eines NEUEN Kontos; ein bestehendes Konto behält seine eigene. Nicht unterstützte Werte werden ignoriert

string
nullable
accept_terms

Die Nutzungsbedingungen des Kontos (platform_terms), die die Person auf Ihrer Website akzeptiert hat — optional, aber wenn angegeben, muss die geltende Version genannt werden

object
version
erforderlich

Die gezeigte geltende Versionsbezeichnung (GET /v1/legal/{kind})

string
sha256

Der Hash der Vorlage, wenn veröffentlicht

string
acknowledge_privacy

Die Datenschutzerklärung der Plattform (platform_privacy), die die Person auf Ihrer Website gelesen hat — optional, dieselbe Regel

object
version
erforderlich

Die gezeigte geltende Versionsbezeichnung (GET /v1/legal/{kind})

string
sha256

Der Hash der Vorlage, wenn veröffentlicht

string

Angenommen

Medientypapplication/json
object
status
erforderlich
string
Erlaubte Werte: accepted
Beispiel
{
"status": "accepted"
}

Ungültige Anfrage

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

Fehlende oder ungültige Zugangsdaten

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

Nicht erlaubt

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

Nicht gefunden

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

Ratenlimit überschritten

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}

Interner Fehler

Medientypapplication/problem+json
object
type
erforderlich
string Format: uri
title
erforderlich
string
status
erforderlich
integer
detail
string
code
erforderlich
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Beispielerzeugt
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"code": "example",
"request_id": "example",
"errors": [
{
"field": "example",
"code": "example",
"message": "example"
}
]
}