POST/v1/cards/{card_id}/verify

Potvrda da je kartica ažurna

verify_card

Autentifikacija

Pošaljite API ključ u zaglavlju Authorization: Authorization: Bearer <ključ>.

Parametri putanje

card_idstringobavezno

Parametri zaglavlja

Idempotency-Keystring
Ključ za siguran ponovni pokušaj upisa: od 1 do 255 ispisivih ASCII znakova; preporučuje se UUID v4 po logičkoj operaciji. Ponovni pokušaj s istim ključem unutar 24 sata ne izvodi operaciju ponovno: vraća spremljeni odgovor (status, zaglavlja i tijelo) sa zaglavljem Idempotency-Replayed: true. Isti ključ s drugom metodom, putanjom, Content-Type ili tijelom vraća 409 api.idempotency_mismatch; dok se prvi zahtjev još izvodi – 409 api.idempotency_in_progress s Retry-After: 1. Nakon odgovora 5xx ili 429 ključ se oslobađa i ponovni pokušaj ponovno izvodi operaciju. Ključ vrijedi u okviru organizacije i pozivatelja (API ključ, korisnik ili ključ vlastitog izvora).
length ≥ 1, length ≤ 255
X-View-Asstring
Samo za API ključeve s ulogom admin. Izvodi zahtjev kao podatkovni profil <profile>[:viewer|verifier|editor], na primjer employee:viewer. Ključ instalacije ne može koristiti ovo zaglavlje (403).

Parametri kolačića

kb_view_asstring
Kolačić načina „View as” za sesiju. Postavlja ga POST /auth/view-as, a briše DELETE /auth/view-as.

Tijelo zahtjeva

application/json

Objekt: VerifyRequest

notestring | null

Odgovori

200Uspješan odgovor

Zaglavlja odgovora

RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.
Idempotency-Replayed
true znači da je odgovor ponovljen iz spremljenog odgovora za ovaj Idempotency-Key: operacija se nije ponovno izvela.

application/json

Objekt: Card

expandedCardExpanded
permissionsObjectPermissionList
accessstring
Dopuštene vrijednosti: wholepartial
access_contactstring
Kome se obratiti za pristup (samo kad je access=partial).
aclobject
Polja
- verifybooleanobavezno
- writebooleanobavezno
categorystringobavezno
category_confidencenumber | nullobavezno
category_lockedbooleanobavezno
category_reviewbooleanobavezno
category_sourceCategorySource | nullobavezno
collectionstringobavezno
collection_idintegerobavezno
collection_titlestring
commentsarray of CardComment
content_jsonContentJSON | null
Sadržaj uređivača posljednje objavljene verzije. Polje može nedostajati; u tom slučaju sadržaj uređivača dohvatite iz nacrta (POST /v1/drafts s card_id).
editing_lockEditingLock | null
Aktivno zaključavanje za uređivanje. Polje može nedostajati; u tom slučaju uređivač saznaje tko drži zaključavanje iz 409 cards.locked na POST /v1/cards/{card_id}/lock.
created_atstring (date-time)obavezno
days_since_verifiedintegerobavezno
errorstring | nullobavezno
eventsarray of CardEvent
feedback_negintegerobavezno
feedback_posintegerobavezno
foldersarray of CardFolderRef
Samo u popisu kartica: mape koje sadrže karticu (one koje korisnik vidi), s putanjama od korijena zbirke. Prazan popis znači da kartica nije ni u jednoj mapi.
has_tablesboolean
Samo u popisu kartica.
hidden_partsboolean
idstringobavezno
jobJob | null
kindCardKindobavezno
org_idintegerobavezno
owner_activeboolean | null
owner_idinteger | nullobavezno
owner_namestring | nullobavezno
pagesinteger | nullobavezno
parserstring | nullobavezno
Program za raščlambu dokumenta kao neutralni kod: document (puna struktura: stranice, naslovi, tablice, skenirane stranice), pdf (tekstni sloj PDF-a), docx, xlsx, csv, markdown, html, text. Popis se može proširiti.
partsarray of CardPartobavezno
sensitivebooleanobavezno
sha256string | nullobavezno
sizeintegerobavezno
snoozed_atstring (date-time) | null
snoozed_byinteger | null
snoozed_untilstring | null
source_changedbooleanobavezno
source_pathstring | nullobavezno
source_urlstring | nullobavezno
statusstringobavezno
Dopuštene vrijednosti: processingreadyerrorarchived
tablesarray of CardTable
tagsarray of stringobavezno
titlestringobavezno
trustnumberobavezno
trust_if_verifiednumber
trust_partsTrustPartsobavezno
updated_atstring (date-time)obavezno
verificationVerificationobavezno
verified_atstring (date-time) | nullobavezno
verified_byinteger | nullobavezno
verified_by_namestring | null
verifier_idsarray of integerobavezno
verifiersarray of object
Polja
- activebooleanobavezno
- idintegerobavezno
- namestringobavezno
verify_interval_daysintegerobavezno
versionintegerobavezno
versionsarray of CardVersion
source_archiveArchiveSource
created_byinteger | null
manual_optionsobject
Postavke ručne raščlambe (pregled).
doc_kindDocKind | null
Vrsta dokumenta. null ako vrsta nije utvrđena (npr. za kartice indeksirane prije uvođenja vrsta dokumenata).
doc_kind_confidencenumber | null
Stupanj sigurnosti u vrstu dokumenta, od 0 do 1.
doc_kind_sourcestring | null
Što je odredilo vrstu: pravila (rules), korisnik (manual) ili automatska klasifikacija. Popis se može proširiti: nepoznatu vrijednost tretirajte kao automatsku klasifikaciju.
Dopuštene vrijednosti: rulesmanualnull
invoiceDocInvoiceExtraction | null
Polja računa, knjižnog odobrenja ili blagajničkog računa (samo za te vrste i samo u kartici, ne u popisu). null ako nemate pristup cijelom dokumentu, jer se polja izvlače iz cijelog dokumenta.
warningsarray of ReviewWarning
Upozorenja raščlambe dokumenta (ReviewWarning; samo u kartici, ne u popisu).
enrichmentCardEnrichmentStatus | null
Status obogaćivanja (samo u kartici, ne u popisu). Vrsta dokumenta, polja računa i financijski zapisi dodaju se u pozadini nakon indeksiranja i mogu se kasnije ponovno izračunati; pojavljuju se u kartici kad su spremni. null znači da status nije dostupan (kartica je indeksirana bez pozadinskog obogaćivanja).
external_idstring | null
ID kartice u sustavu integratora. Jedinstven je u organizaciji među karticama koje ne dolaze iz izvora; null znači da nije postavljen. /v1/cards-by-external-id/{external_id} prema njemu čita i zamjenjuje karticu.
length ≤ 512
metadataMetadata

400Zahtjev nije valjan: vrijednost parametra ili stanje objekta ne dopušta radnju (`detail` je poruka).

Zaglavlja odgovora

RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

401Vjerodajnice nisu poslane (ni kolačić sesije ni API ključ) ili ključ nije pronađen.

Zaglavlja odgovora

RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

403Radnja nije dopuštena: uloga nije dovoljna, nema pristupa zbirci ili kartici, zahtjev se izvodi u načinu „View as” ili je organizacija suspendirana ili izbrisana (`detail` je objekt s `code: org_suspended | org_deleted`).

Zaglavlja odgovora

RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

404Objekt ne postoji ili vam nije dostupan. API ne potvrđuje postojanje ograničenog objekta.

Zaglavlja odgovora

RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

422Pogreška provjere valjanosti: tijelo ili parametri ne odgovaraju shemi (`detail` je popis pogrešaka provjere valjanosti) ili je vrijednost parametra izvan raspona (`detail` je poruka).

Zaglavlja odgovora

RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

429Previše zahtjeva (`api.rate_limited`), kvota organizacije za minutu, dan ili mjesec je potrošena (`api.quota_exceeded`; `error.details` sadrži `quota`, `limit` i `reset_at`), dosegnuto je ograničenje organizacije ili je usluga odgovora zauzeta (`answers.engine_busy`). Pričekajte vrijeme navedeno u zaglavlju `Retry-After`.

Zaglavlja odgovora

Retry-After
Broj sekundi koje treba pričekati prije ponovnog pokušaja zahtjeva.
RateLimit-Policy
Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.
RateLimit
Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).
X-RateLimit-Remaining
Preostali zahtjevi u okviru najstrožeg ograničenja.
X-RateLimit-Reset
Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

Kodovi pogrešaka

Kodovi koje ova operacija može vratiti u error.code, uz opće kodove svakog zahtjeva.

Sigurni ponovni pokušaji

Uz svaki POST i PATCH pošaljite zaglavlje Idempotency-Key (na primjer UUID). Ponovni pokušaj s istim ključem unutar 24 sata vraća spremljeni odgovor umjesto da ponovno izvrši zahtjev.

Ograničenja učestalosti

Odgovori sadrže zaglavlja RateLimit i RateLimit-Policy te ranija zaglavlja X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odgovor 429 sadrži zaglavlje Retry-After u sekundama: pričekajte i pokušajte ponovno.

← cards · Referenca API-ja

curl -X POST 'https://api.sursa.com/v1/cards/CARD_ID/verify' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"note":"string"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Isprobajte

API ključ

Ključ ostaje u memoriji ove kartice preglednika i šalje se samo na https://api.sursa.com.

Zahtjevi djeluju na stvarne podatke vaše organizacije.

Idempotency-Key header

X-View-As header

card_id path *

Idempotency-Key

Ako je polje prazno, za svaki se zahtjev stvara novi ključ.

Tijelo zahtjeva (JSON)