Zum Inhalt springen
Sursa Developers

POST/v1/cards/{card_id}/verify

Bestätigen, dass eine Karte aktuell ist

verify_card

Authentifizierung

Senden Sie einen API-Schlüssel im Header Authorization: Authorization: Bearer <Schlüssel>.

Pfadparameter

  • card_idstringerforderlich

Header-Parameter

  • Idempotency-Keystring

    Schlüssel für die sichere Wiederholung eines Schreibvorgangs: 1 bis 255 druckbare ASCII-Zeichen; empfohlen wird eine UUID v4 pro logischer Operation. Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden führt die Operation nicht erneut aus, sondern liefert die gespeicherte Antwort (Status, Header und Body) mit dem Header Idempotency-Replayed: true. Derselbe Schlüssel mit einer anderen Methode, einem anderen Pfad, Content-Type oder Body ergibt 409 api.idempotency_mismatch; solange die erste Anfrage noch läuft, 409 api.idempotency_in_progress mit Retry-After: 1. Nach einer 5xx- oder 429-Antwort wird der Schlüssel freigegeben, und eine Wiederholung führt die Operation erneut aus. Der Schlüssel gilt pro Organisation und Aufrufer (API-Schlüssel, Benutzer oder Schlüssel einer benutzerdefinierten Quelle).

    length ≥ 1, length ≤ 255

  • X-View-Asstring

    Nur für API-Schlüssel mit der Rolle admin. Führt die Anfrage mit dem Datenprofil <profile>[:viewer|verifier|editor] aus, zum Beispiel employee:viewer. Der Installationsschlüssel kann diesen Header nicht verwenden (403).

Cookie-Parameter

  • kb_view_asstring

    Cookie des Modus „Ansicht als“ für eine Sitzung. POST /auth/view-as setzt es, DELETE /auth/view-as entfernt es.

Anfragetext

application/json

Objekt: VerifyRequest

  • notestring | null

Antworten

200Erfolgreiche Antwort

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

  • Idempotency-Replayed

    true bedeutet, dass die für diesen Idempotency-Key gespeicherte Antwort erneut geliefert wurde: Die Operation wurde nicht noch einmal ausgeführt.

application/json

Objekt: Card

  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    Zulässige Werte: wholepartial

  • access_contactstring

    An wen Sie sich wegen des Zugriffs wenden können (nur bei access=partial).

  • aclobject
    Felder
    • verifybooleanerforderlich
    • writebooleanerforderlich
  • categorystringerforderlich
  • category_confidencenumber | nullerforderlich
  • category_lockedbooleanerforderlich
  • category_reviewbooleanerforderlich
  • category_sourceCategorySource | nullerforderlich
  • collectionstringerforderlich
  • collection_idintegererforderlich
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    Editorinhalt der neuesten veröffentlichten Version. Das Feld kann fehlen; in diesem Fall erhalten Sie den Editorinhalt aus einem Entwurf (POST /v1/drafts mit card_id).

  • editing_lockEditingLock | null

    Aktive Bearbeitungssperre. Das Feld kann fehlen; in diesem Fall erfährt der Editor über 409 cards.locked bei POST /v1/cards/{card_id}/lock, wer die Sperre hält.

  • created_atstring (date-time)erforderlich
  • days_since_verifiedintegererforderlich
  • errorstring | nullerforderlich
  • eventsarray of CardEvent
  • feedback_negintegererforderlich
  • feedback_posintegererforderlich
  • foldersarray of CardFolderRef

    Nur in der Kartenliste: die Ordner, die die Karte enthalten (die für den Benutzer sichtbaren), mit ihren Pfaden ab der obersten Ebene der Sammlung. Eine leere Liste bedeutet, dass die Karte in keinem Ordner liegt.

  • has_tablesboolean

    Nur in der Kartenliste.

  • hidden_partsboolean
  • idstringerforderlich
  • jobJob | null
  • kindCardKinderforderlich
  • org_idintegererforderlich
  • owner_activeboolean | null
  • owner_idinteger | nullerforderlich
  • owner_namestring | nullerforderlich
  • pagesinteger | nullerforderlich
  • parserstring | nullerforderlich

    Dokumentparser als neutraler Code: document (vollständige Struktur: Seiten, Überschriften, Tabellen, gescannte Seiten), pdf (die Textebene des PDF), docx, xlsx, csv, markdown, html, text. Die Liste kann wachsen.

  • partsarray of CardParterforderlich
  • sensitivebooleanerforderlich
  • sha256string | nullerforderlich
  • sizeintegererforderlich
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanerforderlich
  • source_pathstring | nullerforderlich
  • source_urlstring | nullerforderlich
  • statusstringerforderlich

    Zulässige Werte: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringerforderlich
  • titlestringerforderlich
  • trustnumbererforderlich
  • trust_if_verifiednumber
  • trust_partsTrustPartserforderlich
  • updated_atstring (date-time)erforderlich
  • verificationVerificationerforderlich
  • verified_atstring (date-time) | nullerforderlich
  • verified_byinteger | nullerforderlich
  • verified_by_namestring | null
  • verifier_idsarray of integererforderlich
  • verifiersarray of object
    Felder
    • activebooleanerforderlich
    • idintegererforderlich
    • namestringerforderlich
  • verify_interval_daysintegererforderlich
  • versionintegererforderlich
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    Manuelle Einstellungen für das Parsing (Vorschau).

  • doc_kindDocKind | null

    Dokumenttyp. null, wenn der Typ nicht bestimmt ist (zum Beispiel bei Karten, die vor Einführung der Dokumenttypen indexiert wurden).

  • doc_kind_confidencenumber | null

    Konfidenz des Dokumenttyps, von 0 bis 1.

  • doc_kind_sourcestring | null

    Was den Typ bestimmt hat: Regeln (rules), ein Benutzer (manual) oder die automatische Klassifizierung. Die Liste kann wachsen: Behandeln Sie einen unbekannten Wert als automatische Klassifizierung.

    Zulässige Werte: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    Felder einer Rechnung, Gutschrift oder eines Belegs (nur bei diesen Typen und nur in der Karte, nicht in der Liste). null, wenn Sie keinen Zugriff auf das gesamte Dokument haben, da die Felder aus dem gesamten Dokument extrahiert werden.

  • warningsarray of ReviewWarning

    Warnungen beim Parsing des Dokuments (ReviewWarning; nur in der Karte, nicht in der Liste).

  • enrichmentCardEnrichmentStatus | null

    Status der Anreicherung (nur in der Karte, nicht in der Liste). Dokumenttyp, Rechnungsfelder und Finanzeinträge werden nach der Indexierung im Hintergrund hinzugefügt und können später neu berechnet werden; sie erscheinen in der Karte, sobald sie bereit sind. null bedeutet, dass kein Status verfügbar ist (die Karte wurde ohne Hintergrundanreicherung indexiert).

  • external_idstring | null

    ID der Karte im System des Integrators. Die ID ist in der Organisation unter den Karten, die nicht aus Quellen stammen, eindeutig; null bedeutet, dass sie nicht gesetzt ist. /v1/cards-by-external-id/{external_id} liest und ersetzt die Karte anhand dieser ID.

    length ≤ 512

  • metadataMetadata
400Die Anfrage ist ungültig: Ein Parameterwert oder der Zustand des Objekts lässt die Aktion nicht zu (`detail` ist eine Meldung).

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

401Es wurden keine Anmeldedaten gesendet (weder ein Sitzungscookie noch ein API-Schlüssel), oder der Schlüssel wurde nicht gefunden.

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

403Die Aktion ist nicht erlaubt: Die Rolle reicht nicht aus, es besteht kein Zugriff auf die Sammlung oder Karte, die Anfrage läuft im Modus „Ansicht als“, oder die Organisation ist gesperrt oder gelöscht (`detail` ist ein Objekt mit `code: org_suspended | org_deleted`).

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

404Das Objekt existiert nicht oder ist für Sie nicht verfügbar. Die API bestätigt nicht, dass ein eingeschränktes Objekt existiert.

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

422Validierungsfehler: Der Body oder die Parameter entsprechen nicht dem Schema (`detail` ist eine Liste von Validierungsfehlern), oder ein Parameterwert liegt außerhalb des zulässigen Bereichs (`detail` ist eine Meldung).

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

429Zu viele Anfragen (`api.rate_limited`), das Kontingent der Organisation für die Minute, den Tag oder den Monat ist aufgebraucht (`api.quota_exceeded`; `error.details` enthält `quota`, `limit` und `reset_at`), das Limit der Organisation ist erreicht, oder der Antwortdienst ist ausgelastet (`answers.engine_busy`). Warten Sie die im Header `Retry-After` angegebene Zeit ab.

Antwort-Header

  • Retry-After

    Anzahl der Sekunden, die Sie warten sollten, bevor Sie die Anfrage wiederholen.

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

Fehlercodes

Codes, die dieser Endpunkt in error.code zurückgeben kann, zusätzlich zu den allgemeinen Codes jeder Anfrage.

Sichere Wiederholungen

Senden Sie bei jedem POST und PATCH einen Header Idempotency-Key (zum Beispiel eine UUID). Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden gibt die gespeicherte Antwort zurück, statt die Anfrage erneut auszuführen.

Ratenlimits

Antworten enthalten die Header RateLimit und RateLimit-Policy sowie die älteren X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Eine Antwort 429 enthält Retry-After in Sekunden: Warten Sie und versuchen Sie es dann erneut.

← cards · API-Referenz