Documents for signing

List documents for signing

GET/v4/config/ows/verifier/files

Lists the PDF documents that the organisation uploaded for signing. The response has the IDs, names and links, not the content. Download a document with its ID.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/ows/verifier/files' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "file": [
    {
      "id": "83cd38bc-3291-44a4-b40b-aa971275a4b5",
      "fileName": "docs-check-platform-contract.pdf",
      "fileExternalLink": "https://demo-api.igrant.io/organisation/60905277-d953-4ef7-aa4c-cec413d00d93/service/file/83cd38bc-3291-44a4-b40b-aa971275a4b5",
      "createdAt": 1794146622,
      "updatedAt": 1794146622
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 1,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:files:read

Query parameters

offsetinteger
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
At least 0.
Default:0
limitinteger
The number of items in a page, at most 100. Default 10. A value that is not a positive integer gives the default.
At most 100.
Default:10

Response

application/json

One page of documents.

fileobject[]
The documents of the page.
paginationobject