POST  /api/v1/entity/{id}/files

Attach a document you already hold — a credit report, a company profile, a certificate — to an entity. Verety reads it once, stores a digest, and every later investigate call uses that digest: cites it, cross-checks it against the registry, and drops follow-ups the document already answers.

Upload

Send the raw file bytes. Content-Type is the file's own type; the filename goes in the name query parameter.

ACCEPTEDNOTES
PDFText or scanned — scans and photos are read visually.
PNG, JPEG, WebPA photo of a document works.
TXT, CSV, DOCX, XLSXText is extracted directly.
Size8 MB per file.

The response is 202 with the file in state pending. The read finishes in the background, usually within a few seconds.

List

GET  /api/v1/entity/{id}/files returns every document on file for this entity under your key, with its read status and digest. Poll it after an upload until the file is ready.

FIELDDESCRIPTION
statuspending · ready · failed (with an error reason).
digest.documentTypeWhat the document is, e.g. "ACRA Business Profile".
digest.issuer, digest.subjectWho issued it, who it is about.
digest.dates[]Material dates printed in the document.
digest.summary, digest.findings[]What it shows, and the structured facts it contains.
digest.risk, digest.compThe same LOW/MED/HIGH and PASS/REVIEW/FAIL scales as every other check.

Ownership

Documents belong to the key's account. Another account investigating the same entity never sees them, and document links inside a report open only for the account that uploaded them.

Errors

STATUSCODEWHEN
400missing_name · empty_fileNo filename, or no bytes.
403country_not_entitledThe id belongs to a country outside your key.
404unknown_idThe id prefix matches no connected registry.
413file_too_largeOver 8 MB.
415unsupported_typeNot one of the accepted types.

Example

curl -X POST -H "x-api-key: vk_live_…" -H "Content-Type: application/pdf" \ --data-binary @acra-profile.pdf \ "https://app.verety.ai/api/v1/entity/uen-201912345K/files?name=acra-profile.pdf" # a few seconds later curl -H "x-api-key: vk_live_…" "https://app.verety.ai/api/v1/entity/uen-201912345K/files"
ON THIS PAGE