Skip to main content

​
Endpoint

GET /v1/docstream/extracts

​
Request headers

​
Token
string
required
JWT access token obtained from POST /authtoken.

​
Query parameters

​
batch_id
string
required
The batch identifier returned from the upload API. Atlas returns extracted document data associated with this batch.Example: BATCH-69469-BBRSS-20260309081408
​
page
integer
Page number for pagination.Default: 1
​
per_page
integer
Number of records returned per page.Default: 50

​
Response

​
data
array
Array of extracted document results.
​
document_id
string
The document identifier provided during upload.
​
file_data
object
Structured OCR output for the document. Fields vary depending on the detected document type.
​
page
integer
Current page number.
​
per_page
integer
Number of records returned in the response.
​
total_pages
integer
Total number of pages available.
​
total_items
integer
Total number of extracted documents available.
​
has_next
boolean
Indicates whether additional pages are available.
​
has_prev
boolean
Indicates whether previous pages are available.

​
Example

curl --request GET \
  --url "https://docstream.dev.kreditmind.com/v1/docstream/extracts?batch_id=BATCH-69469-BBRSS-20260309081408&page=1&per_page=50" \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
Understanding the response

The data array contains one object for each processed document in the batch. Each document includes:
FieldDescription
document_idYour identifier provided during upload
file_data.document_typeAtlas-classified document type
file_data.*Extracted OCR fields specific to that document type
Every extracted field contains: 
{
  "value": "ABCDE1234E",
  "confidence_score": 0.95
}
The confidence_score ranges from 0 to 1 and represents Atlas’s confidence in the extracted value.

​
Callback support

Instead of polling the extracts endpoint, Atlas can deliver extraction results directly to your system through a callback URL. When callback integration is enabled for your account:
  1. Atlas processes the uploaded documents.
  2. Atlas sends the extraction results to your configured callback_url.
  3. Your endpoint receives the same extraction payload automatically when processing is complete.
To enable callbacks, share the following with the Atlas team:
  • Your callback_url where results should be delivered
  • Your auth_url used by Atlas to authenticate before sending callbacks
Atlas maintains the callback configuration on our side, so no additional parameters are required in upload requests.
Callbacks are recommended for production integrations because they eliminate the need to continuously poll the extracts endpoint and allow your systems to receive results as soon as processing completes.

​
Error responses

StatusMeaning
400batch_id is required — the batch identifier was not provided in the request.
401Invalid or expired token — the authentication token is missing, invalid, or expired.