Direct naar de inhoud
Sursa Developers

GET/v1/cards-by-external-id/{external_id}

Kaart ophalen op externe ID

get_card_by_external_id

Geeft dezelfde kaart terug, met dezelfde toegangscontroles als GET /v1/cards/{card_id}, geadresseerd via de external_id van de integrator. Als de organisatie geen kaart met deze external_id heeft, of de kaart niet zichtbaar is voor de aanroeper, geeft het request 404 cards.not_found.

Authenticatie

Stuur een API-sleutel mee in de header Authorization: Authorization: Bearer <sleutel>.

Padparameters

  • external_idstringverplicht

    external_id van de kaart: een tekenreeks van 1–512 tekens, uniek binnen de organisatie.

    length ≥ 1, length ≤ 512

Queryparameters

  • expand[]array of string

    Gerelateerde objecten die in de response worden opgenomen (sinds 1.62.0): een pad uit de lijst x-expandable van de bewerking. Herhaal de parameter maximaal 10 keer. Een pad heeft maximaal 2 segmenten, gescheiden door een punt (collection.default_owner). In een lijst begint het pad met data. en geldt het voor elk item van de pagina (expand[]=data.owner). Een uitgevouwen object komt in het object expanded van het item, en het ID-veld blijft staan. Een object dat de aanroeper volgens de controles van de eigen leesbewerking ervan niet mag zien, wordt uitgevouwen als null. Een onbekend pad, meer dan 10 paden of een pad dieper dan 2 segmenten geeft 400 api.expand_invalid.

    items ≤ 10

Headerparameters

  • X-View-Asstring

    Alleen voor API-sleutels met de rol admin. Voert het request uit als het dataprofiel <profile>[:viewer|verifier|editor], bijvoorbeeld employee:viewer. De installatiesleutel kan deze header niet gebruiken (403).

Cookieparameters

  • kb_view_asstring

    Cookie van de modus “View as” voor een sessie. POST /auth/view-as zet hem en DELETE /auth/view-as wist hem.

Responses

200Geslaagde response

Responseheaders

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Card

  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    Toegestane waarden: wholepartial

  • access_contactstring

    Bij wie je toegang kunt aanvragen (alleen bij access=partial).

  • aclobject
    Velden
    • verifybooleanverplicht
    • writebooleanverplicht
  • categorystringverplicht
  • category_confidencenumber | nullverplicht
  • category_lockedbooleanverplicht
  • category_reviewbooleanverplicht
  • category_sourceCategorySource | nullverplicht
  • collectionstringverplicht
  • collection_idintegerverplicht
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    Editorinhoud van de laatste gepubliceerde versie. Het veld kan ontbreken; haal de editorinhoud dan uit een concept (POST /v1/drafts met card_id).

  • editing_lockEditingLock | null

    Actieve bewerkingsvergrendeling. Het veld kan ontbreken; de editor ziet dan wie de vergrendeling heeft aan 409 cards.locked op POST /v1/cards/{card_id}/lock.

  • created_atstring (date-time)verplicht
  • days_since_verifiedintegerverplicht
  • errorstring | nullverplicht
  • eventsarray of CardEvent
  • feedback_negintegerverplicht
  • feedback_posintegerverplicht
  • foldersarray of CardFolderRef

    Alleen in de lijst van kaarten: de mappen die de kaart bevatten (die de gebruiker ziet), met hun paden vanaf het hoofdniveau van de collectie. Een lege lijst betekent dat de kaart in geen enkele map staat.

  • has_tablesboolean

    Alleen in de lijst van kaarten.

  • hidden_partsboolean
  • idstringverplicht
  • jobJob | null
  • kindCardKindverplicht
  • org_idintegerverplicht
  • owner_activeboolean | null
  • owner_idinteger | nullverplicht
  • owner_namestring | nullverplicht
  • pagesinteger | nullverplicht
  • parserstring | nullverplicht

    Documentparser als neutrale code: document (volledige structuur: pagina’s, koppen, tabellen, gescande pagina’s), pdf (de tekstlaag van de PDF), docx, xlsx, csv, markdown, html, text. De lijst kan groeien.

  • partsarray of CardPartverplicht
  • sensitivebooleanverplicht
  • sha256string | nullverplicht
  • sizeintegerverplicht
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanverplicht
  • source_pathstring | nullverplicht
  • source_urlstring | nullverplicht
  • statusstringverplicht

    Toegestane waarden: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringverplicht
  • titlestringverplicht
  • trustnumberverplicht
  • trust_if_verifiednumber
  • trust_partsTrustPartsverplicht
  • updated_atstring (date-time)verplicht
  • verificationVerificationverplicht
  • verified_atstring (date-time) | nullverplicht
  • verified_byinteger | nullverplicht
  • verified_by_namestring | null
  • verifier_idsarray of integerverplicht
  • verifiersarray of object
    Velden
    • activebooleanverplicht
    • idintegerverplicht
    • namestringverplicht
  • verify_interval_daysintegerverplicht
  • versionintegerverplicht
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    Handmatige instellingen voor het parseren (voorbeeld).

  • doc_kindDocKind | null

    Documenttype. null als het type niet is bepaald (bijvoorbeeld bij kaarten die zijn geïndexeerd voordat er documenttypen waren).

  • doc_kind_confidencenumber | null

    Zekerheid over het documenttype, van 0 tot 1.

  • doc_kind_sourcestring | null

    Wat het type heeft bepaald: regels (rules), een gebruiker (manual) of automatische classificatie. De lijst kan groeien: behandel een onbekende waarde als automatische classificatie.

    Toegestane waarden: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    Velden van een factuur, creditnota of bon (alleen voor deze typen, en alleen in de kaart, niet in de lijst). null als je geen toegang hebt tot het hele document, want de velden worden uit het hele document gehaald.

  • warningsarray of ReviewWarning

    Waarschuwingen bij het parseren van het document (ReviewWarning; alleen in de kaart, niet in de lijst).

  • enrichmentCardEnrichmentStatus | null

    Verrijkingsstatus (alleen in de kaart, niet in de lijst). Het documenttype, de factuurvelden en de financiële records worden na het indexeren op de achtergrond toegevoegd en kunnen later opnieuw worden berekend; ze verschijnen in de kaart zodra ze klaar zijn. null betekent dat er geen status beschikbaar is (de kaart is geïndexeerd zonder verrijking op de achtergrond).

  • external_idstring | null

    ID van de kaart in het systeem van de integrator. Uniek in de organisatie onder kaarten die niet uit bronnen komen; null betekent dat die niet is ingesteld. /v1/cards-by-external-id/{external_id} leest en vervangt de kaart op basis daarvan.

    length ≤ 512

  • metadataMetadata
400Het request is ongeldig: een parameterwaarde of de toestand van het object staat de actie niet toe (`detail` is een melding).

Responseheaders

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Error

401Er zijn geen authenticatiegegevens meegestuurd (geen sessiecookie en geen API-sleutel), of de sleutel is niet gevonden.

Responseheaders

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Error

403De actie is niet toegestaan: de rol volstaat niet, er is geen toegang tot de collectie of kaart, het request draait in de modus “View as”, of de organisatie is opgeschort of verwijderd (`detail` is een object met `code: org_suspended | org_deleted`).

Responseheaders

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Error

404Het object bestaat niet of is niet voor jou beschikbaar. De API bevestigt niet dat een afgeschermd object bestaat.

Responseheaders

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Error

422Validatiefout: de body of de parameters komen niet overeen met het schema (`detail` is een lijst met validatiefouten), of een parameterwaarde valt buiten het bereik (`detail` is een melding).

Responseheaders

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Error

429Te veel requests (`api.rate_limited`), het quotum van de organisatie voor de minuut, dag of maand is op (`api.quota_exceeded`; `error.details` bevat `quota`, `limit` en `reset_at`), de limiet van de organisatie is bereikt, of de antwoorddienst is bezet (`answers.engine_busy`). Wacht de tijd af die in de header `Retry-After` staat.

Responseheaders

  • Retry-After

    Aantal seconden dat je moet wachten voordat je het request opnieuw probeert.

  • RateLimit-Policy

    Geldende limieten, in het formaat van het IETF-concept draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s, "<name>";q=<quota>;w=<window in seconds>. key is de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is het user, zonder authenticatiegegevens ip); minute, day en month zijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.

  • RateLimit

    Wat er over is van elke limiet in RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limiet van de strengste regel in RateLimit-Policy (die met de minste resterende requests).

  • X-RateLimit-Remaining

    Resterende requests onder de strengste limiet.

  • X-RateLimit-Reset

    Seconden tot de strengste limiet wordt teruggezet.

application/json

Object: Error

Foutcodes

Codes die dit endpoint in error.code kan teruggeven, naast de algemene codes van elk request.

Snelheidslimieten

Responses bevatten de headers RateLimit en RateLimit-Policy en de eerdere X-RateLimit-Limit, X-RateLimit-Remaining en X-RateLimit-Reset. Een response met status 429 bevat Retry-After in seconden: wacht en probeer het daarna opnieuw.

← cards · API-referentie