JUjustifi
Document

List Documents

List the documents you have uploaded. This endpoint supports pagination.

get/entities/document

Request

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Successfully list documents

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "data": [
    {
      "id": "doc_abc123",
      "platform_account_id": "acc_123xyz",
      "description": "My Document",
      "file_name": "my_document",
      "file_type": "pdf",
      "document_type": "balance_sheet",
      "business_id": "biz_abc123",
      "identity_id": "idty_abc123",
      "presigned_url": "https://test.test/doc_abc123/file_name.pdf",
      "metadata": {
        "language": "english",
        "social_network": "@person"
      },
      "created_at": "2021-01-01T12:00:00Z",
      "updated_at": "2021-01-01T12:00:00Z"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.