Skip to main content
POST
OCR a file from URL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required
x-organization-id
string<uuid>

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
file_url
string
required
document_type
enum<string>
Available options:
invoice,
credit_note,
receipt

Response

OCR task has been accepted for execution.

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
source
enum<string>
required
Available options:
internal,
external
status
enum<string>
required
Available options:
processing,
success,
error
document_type
enum<string>
Available options:
invoice,
credit_note,
receipt
recognized_data
object