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
f52b1f9e-b9a6-4248-afc5-d3ae358e723aHeader 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
activities
required
List of document activities
Array<object>
object
documentId
required
The document id
string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a activityId
required
The activity id
string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a organisationId
required
The organisation id
string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a eventSignature
required
The event signature
string
io.fsco.ocr.event.ocrStarted activityType
required
The activity type
string
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
The current page number.
number
1 size
required
The number of items per page.
number
10 totalPages
required
The total number of pages available.
number
100 totalCount
required
The total number of items available.
number
1000 hasNext
required
Indicates whether there is a next page available.
boolean
true hasPrev
required
Indicates whether there is a previous page available.
boolean
true