State

Document Status

stateDiagram-v2
    [*] --> pending
    pending --> inprogress
    inprogress --> finished
    inprogress --> system_error
    finished --> [*]
    system_error --> [*]

• pending: Initial status after user made request. The credit is not deducted.
• inprogress: System starts processing the request. The credit is deducted.
• finished: Document has been processed successfully
• system_error: System rejected document processing due to document is unpredictable or system internal issue. Credit will be refunded.

Batch Status

stateDiagram-v2
    [*] --> awaiting_upload
    awaiting_upload --> inprogress
    inprogress --> finished
    inprogress --> system_error
    finished --> [*]
    system_error --> [*]

• awaiting_upload: Initial status after user made request. User then needs to upload files by list of returned upload_id
• inprogress: System starts processing the request. The credit is deducted.
• finished: Batch has been processed successfully
• system_error: System rejected batch processing due to batch is unpredictable or system internal issue. Failed documents related to failed batch will have credits refunded. Successful documents won’t have credits refunded even if batch is failed.