Skip to main content
GET
/
v2
/
documents
List Documents
curl --request GET \
  --url https://api.avenia.io:8443/v2/v2/documents \
  --header 'Authorization: Bearer <token>'
{
  "documents": [
    {
      "id": "<string>",
      "documentType": "<string>",
      "uploadStatus": "<string>",
      "verificationStatus": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "cursor": "<string>"
}

List Documents

GET request to /v2/documents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

subAccountId
string

Sub-account ID

createdAfter
integer

Filter documents created after timestamp

createdBefore
integer

Filter documents created before timestamp

documentType
string

Filter by document type

cursor
string

Cursor for pagination

Response

OK

documents
object[]
required
cursor
string
required