v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

documents

Get document upload status

Get status of a document upload. Use this endpoint to identify when a document upload is complete.

BILL generates an uploadId for the document when the upload is in progress (IN_PROGRESS). The value begins with 0du.
BILL generates a documentId for the document when the upload is complete (UPLOADED). The value begins with 00h.

get/v3/documents/upload-status

idsstring required

Document upload IDs. You can set the IDs as comma-separated values.

Example:{{document_upload_id}}

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Get document upload status response

documentIdstring

BILL-generated ID of the document. The value begins with 00h.

uploadIdstring

BILL-generated ID of the document upload. The value begins with 0du.

status'UPLOADED' | 'IN_PROGRESS' | 'IVA_PROCESSING' | 'AUTOSAVED' | 'FAILED'

Document upload status.

Document scan status.