GET /chat-history — Retrieve Chat Messages

This endpoint returns the most recent chat messages for a given flow. It supports pagination so you can fetch messages incrementally. Use this to:

Display chat history in your UI
Resume conversations
Audit onboarding interactions

Endpoint

GET /verification/chat-history

Request headers

string

required

JWT access token for authentication.

Query parameters

string

required

Unique identifier for the chat flow.

integer

Page number to retrieve. Default: 1.

integer

Number of messages per page. Default: 10.

Response

array

List of chat messages.

integer

Current page number.

integer

Number of messages per page.

integer

Total number of pages available.

integer

Total number of messages.

boolean

Indicates if more pages are available.

boolean

Indicates if previous pages exist.

Example

curl --request GET \
  --url "https://api.helloatlas.in/v2/verification/chat-history?flow_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&page=1&per_page=10" \
  --header "Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

{
  "data": [
    {
      "message": "how are you?",
      "sender": "user",
      "external_document_id": "9a21f55e-3d7b-40b3-b8e0-bf31c73059e6",
      "created_at": "2025-10-11T06:01:03"
    }
  ],
  "page": 1,
  "per_page": 10,
  "total_pages": 5,
  "total_items": 100,
  "has_next": true,
  "has_prev": false
}

Error responses

Status	Meaning
`400`	Invalid parameters (e.g., `page` must be integer)
`401`	Invalid or expired token

Messages include both user and system responses. Use the sender field to differentiate between them when rendering the chat UI.

Authentication

IDP Extraction

Document Verification

Chat Based Onboarding

Bulk Service

Address Match

GET /chat-history — Retrieve Chat Messages

Endpoint

Request headers

Query parameters

Response

Example

Error responses

​Endpoint

​Request headers

​Query parameters

​Response

​Example

​Error responses

Endpoint

Request headers

Query parameters

Response

Example

Error responses