Ist ein Antragsteller ein berechtigtes Mitglied?

Fragt, ob ein Antragsteller, der nicht angemeldet sein muss, ein berechtigtes Mitglied der Community des aufrufenden Frontends ist, anhand der Mitgliedsnummer und der Angaben, die er eingegeben hat. Jeder Aufruf ist eine Mitgliedschaftsprüfung im Prüfmodus Berechtigung und wird mit der IP-Adresse des Antragstellers im Prüfprotokoll des Studios festgehalten.

Die Antwort ist nur der Status, nie der Grund: Eine unbekannte Mitgliedsnummer und eine bekannte mit anderen Angaben erhalten denselben Status, dieselben Header und denselben Inhalt. Zu viele fehlgeschlagene Prüfungen für eine Mitgliedsnummer, aus einem Netz von Antragstellern (eine IPv4-Adresse oder ein IPv6-/64) oder bei einem Frontend werden mit 429 abgewiesen.

Authentifizierung

• frontendKey (HTTP-Bearer-Token im Format ofk_<prefix>_<secret>): Der Frontend-Schlüssel des Frontends, im Studio auf der Seite des Frontends ausgestellt und einmal angezeigt: Authorization: Bearer ofk_…. Bis zu zwei sind gleichzeitig aktiv, sodass ein Schlüssel ohne Unterbrechung gewechselt werden kann.

Parameter

Request-Body

JSON, höchstens 4 KB. Andere Felder werden ignoriert.

Inhaltstyp: application/json, erforderlich

Beispiel: Ein Antragsteller

{
  "memberCode": "108900",
  "firstName": "Jürgen",
  "lastName": "Weiß",
  "birthDate": "1962-07-07"
}

Antworten

200

Geprüft. valid: ein berechtigtes Mitglied der Community des Frontends. not_valid: nicht, aus welchem Grund auch immer. unavailable: Ein Register konnte nicht antworten; fragen Sie später erneut.

Inhaltstyp: application/json

Beispiel: Ein berechtigtes Mitglied

{
  "status": "valid"
}

Beispiel: Kein berechtigtes Mitglied

{
  "status": "not_valid"
}

Beispiel: Ein Register konnte nicht antworten

{
  "status": "unavailable"
}

400

Ein Inhalt, der kein JSON ist oder bei dem ein Feld fehlt oder ungültig ist, oder ein fehlender oder ungültiger X-Applicant-IP-Header. Welches davon, wird nicht gesagt.

Inhaltstyp: application/json

Beispiel: Eine ungültige Anfrage

{
  "error": "invalid_request"
}

401

Kein Frontend-Schlüssel, oder einer, der fehlerhaft, unbekannt oder widerrufen ist, oder der Schlüssel eines getrennten Frontends. Jeder Fall erhält dieselbe Antwort.

Header

Inhaltstyp: application/json

Beispiel: Nicht authentifiziert

{
  "error": "unauthenticated"
}

413

Ein Inhalt über 4 KB.

Inhaltstyp: application/json

Beispiel: Zu groß

{
  "error": "too_large"
}

429

Zu viele fehlgeschlagene Prüfungen für diese Mitgliedsnummer, aus dem Netz dieses Antragstellers (die IPv4-Adresse oder das /64, in dem eine IPv6-Adresse liegt) oder bei diesem Frontend. Es wurde kein Register gefragt. Es gibt kein Retry-After.

Inhaltstyp: application/json

Beispiel: Ratenlimit erreicht

{
  "error": "rate_limited"
}

503

Das Studio selbst ist ausgefallen, nicht ein Register (das wäre eine 200 mit unavailable). Versuchen Sie es später erneut; der Schlüssel ist in Ordnung.

Inhaltstyp: application/json

Beispiel: Das Studio ist nicht verfügbar

{
  "error": "unavailable"
}