OZozav
Screenings

Analyze one document

Reads one document and returns a verdict, its reason, what was compared and the fields read, with no customer and no stored record. The same reader and rules OZAV uses on its own onboarding documents.

Send the file as base64 (up to 3 MB; PDF, JPEG, PNG or WebP) with its document_type. Send subject to compare the holder and the address against who the document should belong to; without it, comparisons say not_compared and the verdict covers the rest (legibility, the right kind of document, its age, signs of editing).

  • verdict: accepted - the document is what was asked and nothing holds it.
  • verdict: review - a person should look; reason says why.
  • verdict: rejected - unreadable, the wrong kind of document, or too old for its purpose.

Every verdict, rejected included, is a real answer and is charged. A file that cannot be analyzed (empty, too large, content not matching mime_type, password-protected PDF) is 400 INVALID_FILE. When the document cannot be analyzed right now, the answer is 503 DOCUMENT_ANALYSIS_UNAVAILABLE: it says nothing about the document. The charge for either is refunded.

Nothing about the document is stored, so this operation takes no Idempotency-Key: a retry is a new analysis.

post/documents/analyze

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

document_type'proof_of_address' | 'bank_statement' | 'tax_return' | 'financial_statement' | 'incorporation_articles' | 'shareholder_registry' | 'directors_registry' | 'tax_registration' | 'identity_document' required

What the document should be. The same vocabulary as the customer document upload. identity_document reads a national ID card, a driver's license, a passport, a residence card or a foreign national ID: the type, the printed holder data and the expiry date, compared with subject. It does not check authenticity (templates, holograms, the machine-readable zone, screen captures) and the answer says so with authenticity_checked: false.

Response

The analysis.

object'document_analysis' required
document_typestring required
verdict'accepted' | 'review' | 'rejected' required
confidencenumber nullable required

How confident the reading is. null for identity_document, whose reading has no score.

authenticity_checkedboolean

Only on identity_document, always false: the printed data is read and compared, the document is not checked for genuineness. An accepted means legible, of an accepted type, in date, and, when you sent the holder, at least one field matched and none differed.

rule_versionstring required

Changes

No recorded changes to this operation across all 1 revision of this API.