List uploaded documents

List user-uploaded documents by filter type.

GET /api/v1/documents

List uploaded documents

cURL

curl --request GET \
  --url https://api.example.com/api/v1/documents \
  --header 'Authorization: Bearer <token>'

200

{
  "documents": [
    {
      "id": "<string>",
      "type": "certificate_of_incorporation",
      "name": "<string>",
      "originName": "<string>",
      "link": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "issueDate": "2023-12-25",
      "expiryDate": "2023-12-25",
      "content": {},
      "dakotaId": "<string>",
      "signature": {
        "state": "draft",
        "signatureRequestId": "<string>",
        "signerEmails": [
          "<string>"
        ],
        "lastSignerEmail": "<string>",
        "testMode": false
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

x-api-key · string | null

Query Parameters

doc_type · string · default: uploaded

Document filter type, e.g. 'uploaded'

Response

200

application/json

Successful Response

Response for user-uploaded documents list.

documents · DocumentDraftInfo · object[] · required

Show child attributes