Get activity
GET /v2/document/{documentId}/activity
GET
/v2/document/{documentId}/activity
Get a document activity by document ID
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” documentId
required
string
A document Id
Example
77a0049c-7683-45ff-956f-656f257048f7Query Parameters
Section titled “Query Parameters ” page[number]
number
Page number (starts at 1)
Example
1 page[size]
number
Items per page
Example
10Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Responses
Section titled “ Responses ”The document activity.
object
items
required
List of document activities
Array<object>
object
activityId
required
The activity id
string format: uuid
77a0049c-7683-45ff-956f-656f257048f7 documentId
required
The document id
string format: uuid
77a0049c-7683-45ff-956f-656f257048f7 eventSignature
required
The event signature
string
io.fsco.ocr.event.ocrStarted payload
required
The activity payload
string
createdAt
required
The date the document activity was created
string
2021-01-01T00:00:00.000Z page
required
The pagination query
object
number
required
Page number (starts at 1)
number
1 size
required
Items per page
number
10 totalPages
required
Total number of items
number
100 totalCount
required
Total number of pages
number
10 hasNext
required
Whether there is a next page
boolean
true hasPrev
required
Whether there is a previous page
boolean
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error