GET /bulk/extracts — Retrieve Batch Results

After you submit a batch with POST /bulk/multiupload, use this endpoint to retrieve the extracted document data. Results are returned as a paginated list keyed by your original document_id values. Call this endpoint repeatedly until you have collected all pages.

Endpoint

GET /bulk/extracts

Authentication

Pass the JWT token from POST /bulk/authtoken in the Token request header.

Request headers

string

required

JWT access token issued by POST /bulk/authtoken.

Query parameters

string

required

The batch identifier returned by POST /bulk/multiupload (e.g., "BATCH-69469-BBRSS-20260309081408").

integer

default:"1"

Page number to retrieve. Starts at 1.

integer

default:"50"

Number of document records to return per page. Maximum is 50.

Response

array

List of extracted document results for this page.

Show data item properties

string

The document_id you supplied when uploading this file.

object

Extracted fields from the document. The structure varies depending on the document_type Atlas detected. Each field is returned as an object with a value and a confidence_score.

integer

The current page number in the result set.

integer

Number of records returned on this page.

integer

Total number of pages available for this batch.

integer

Total number of documents in this batch.

boolean

true if there are more pages after this one.

boolean

true if there are pages before this one.

Error responses

Status	Meaning
`400`	Bad Request — `batch_id` is missing or invalid.
`401`	Unauthorized — the token is missing, invalid, or expired.

Example

curl --request GET \
  --url 'https://api.helloatlas.in/v1/bulk/extracts?batch_id=BATCH-69469-BBRSS-20260309081408&page=1&per_page=50' \
  --header 'Token: <YOUR_JWT_TOKEN>'

{
  "data": [
    {
      "document_id": "1",
      "file_data": {
        "document_type": "AADHAAR",
        "name": {
          "value": "D MANIKANDAN DURAISAMY",
          "confidence_score": 0.95
        },
        "date_of_birth": {
          "value": "16/07/1986",
          "confidence_score": 0.98
        },
        "address": {
          "value": "4-CH-64, NEAR COMMUNITY HALL, BHILWARA, BHILWARA, Bhilwara, Rajasthan, 311001",
          "confidence_score": 0.95
        },
        "aadhaar_number": {
          "value": "1234 5678 9012",
          "confidence_score": 0.99
        }
      }
    }
  ],
  "page": 1,
  "per_page": 50,
  "total_pages": 1,
  "total_items": 1,
  "has_next": false,
  "has_prev": false
}

If has_next is true, increment the page parameter and call this endpoint again until you have retrieved all pages.

Authentication

IDP Extraction

Document Verification

Chat Based Onboarding

Bulk Service

Address Match

GET /bulk/extracts — Retrieve Batch Results

Endpoint

Authentication

Request headers

Query parameters

Response

Error responses

Example

​Endpoint

​Authentication

​Request headers

​Query parameters

​Response

​Error responses

​Example

Endpoint

Authentication

Request headers

Query parameters

Response

Error responses

Example