--- agentTools: projectIndex: https://docs.silamoney.com/llms.txt --- # /list_documents List previously uploaded KYC docs for a specified entity. Returns a list of documents previously uploaded for a specified user\_handle with optional filters in the request. > 👍 This doc has been updated with Priority specifications. *** # Request ## Pagination This endpoint supports pagination via URL query parameters: ``` /list_documents?page=1&per_page=20&order=asc ``` * **page**: page number to retrieve. default: 1 * **per\_page**: number of items per page. default: 20, max: 100 * **order**: sort returned items (usually by creation date). Allowed values: `asc` (default), `desc` ## Authorization / Authentication #### Apps using Access Token Authorization Use a valid access token in a Authorization: Bearer request header. See [Authenticating with an Access Token](authenticating-with-an-access-token) for more details. #### Apps using ECDSA Authentication Both `authsignature` and `usersignature` headers are required for this request. See the section on [ECDSA Authentication](authentication) for more detail about ECDSA signature generation. ```json Specs POST /0.2/list_documents HTTP/1.1 sandbox.silamoney.com Content-Type: application/json // if using OAuth2 Authorization: Bearer [GENERATED JWT TOKEN HERE] // if using ECDSA authsignature: [GENERATED AUTHSIGNATURE HEX STRING HERE] usersignature: [GENERATED USERSIGNATURE HEX STRING HERE] { "header": { "created": 1234567890, "app_handle": "app_handle", "user_handle":"user_handle", "version": "0.2", "reference": "" }, "start_date": "2020-07-31", "end_date": "2020-08-07", "doc_types": [ "id_drivers_license", "id_passport" ], "search": "my_CA_drivers_license", "sort_by": "name" } *** HTTP/1.1 200 OK { "success": true, "status": "SUCCESS", "reference": "", "sila_reference_id": "sila_assigned_id", "response_time_ms": "171", "documents": [ { "user_handle": "user_handle", "document_id": "279687a0-30c6-463d-85bc-eee9bf395e21", "name": "passport_2017", "filename": "img_201901022_034923", "hash": "075f0956584cfa8d32beb384fcf51ce3ee30a7e5aeee6434acc222928a30db3e", "type": "id_passport", "size": "12345678", "created": "2020-08-03T17:09:24.917939" } ], "pagination": { "returned_count": 2, "total_count": 2, "current_page": 1, "total_pages": 1 } } ``` ```javascript JavaScript const filters = { page: 1, perPage: 1, order: 'asc', startDate: '2020-10-30'), endDate: '2020-10-30', docTypes: ['doc_green_card'], search: 'logo', sortBy: 'name', }; const res = await sila.listDocuments(userHandle, userPrivateKey, filters); // Success Response Object console.log(res.statusCode); // 200 console.log(res.data.success); // true console.log(res.data.status); // SUCCESS console.log(res.data.documents); // An array of documents console.log(res.data.pagination); // Pagination information (returned_count, total_count, current_page, total_pages) ``` ```python Python payload = { "user_handle": user_handle, "start_date": "2020-01-01", # Optional "end_date": "2020-12-31", # Optional "doc_types": ["id_drivers_license"], # Optional "search": "my CA driver", # Optional "sort_by": "name" # Optional } page = 1 # Optional per_page = 20 # Optional order = "asc" # Optional. Only asc or desc are allowed response = silasdk.Documents.listDocuments(app, payload, user_private_key, page, per_page, order) # Success Response Object { "status_code": 200, "success": true, "status": "SUCCESS", "documents": [ { "user_handle": "user_handle", "document_id": "279687a0-30c6-463d-85bc-eee9bf395e21", "name": "passport_2017", "filename": "img_201901022_034923", "hash": "075f0956584cfa8d32beb384fcf51ce3ee30a7e5aeee6434acc222928a30db3e", "type": "id_passport", "size": "12345678", "created": "2020-08-03T17:09:24.917939" }, ... ], "pagination": { "returned_count": 2, "total_count": 2, "current_page": 1, "total_pages": 1 } } ``` ```java Java List docTypes = new ArrayList(); docTypes.add("doc_green_card"); // With no pagination ListDocumentsMessage message = ListDocumentsMessage.builder() .userHandle("user_handle") .userPrivateKey("user_private_key") .order("asc") // Optional. Sort returned items (usually by creation date). Allowed values: asc (default), desc .search("logo") // Optional. Only return documents whose name or filename contains the search value. Partial matches allowed, no wildcards. .sortBy("name") // Optional. One of: name or date .docTypes(docTypes) // Optional. A list of strings of supported document types .startDate(LocalDate.now()) // Optional. Only return documents created on or after this date. .endDate(LocalDate.now()) // Optional. Only return documents created before or on this date. .build(); ApiResponse response = api.listDocuments(message); // With pagination PaginationMessage pagination = PaginationMessage.builder() .page(1) // Optional. Page number to retrieve. default: 1 .perPage(40) // Optional. Number of items per page. default: 20, max: 100 .build(); ApiResponse response = api.listDocuments(message, pagination); // Success Response System.out.println(response.getStatusCode()); // 200 ListDocumentsResponse parsedResponse = (ListDocumentsResponse) response.getData(); System.out.println(parsedResponse.getSuccess()); // true System.out.println(parsedResponse.getStatus()); // SUCCESS System.out.println(parsedResponse.getPagination().getCurrentPage()); // 1 System.out.println(parsedResponse.getPagination().getReturnedCount()); // 1 System.out.println(parsedResponse.getPagination().getTotalCount()); // 1 System.out.println(parsedResponse.getPagination().getTotalPages()); // 1 System.out.println(parsedResponse.getDocuments().get(0).getUserHandle()); // user_handle System.out.println(parsedResponse.getDocuments().get(0).getDocumentId()); // some-uuid-code System.out.println(parsedResponse.getDocuments().get(0).getName()); // logo System.out.println(parsedResponse.getDocuments().get(0).getFilename()); // logo System.out.println(parsedResponse.getDocuments().get(0).getHash()); // yourfilehash System.out.println(parsedResponse.getDocuments().get(0).getType()); // doc_green_card System.out.println(parsedResponse.getDocuments().get(0).getSize()); // 211341 System.out.println(parsedResponse.getDocuments().get(0).getCreated()); // 2020-08-03T17:09:24.917939 ``` ```php PHP $userHandle = 'user_handle'; $privateKey = 'some private key'; $page = '1'; // Optional. Page number to retrieve. Default: 1 $perPage = '10'; // Optional. Number of items per page. Default: 20, Max: 100 $sort = 'desc'; // Optional. Sort returned items. Allowed values: asc (default), desc $startDate = new DateTime::createFromFormat('m/d/Y', '1/8/2020'); // Optional. Only return documents created on or after this date. $endDate = new DateTime::createFromFormat('m/d/Y', '1/8/2020'); // Optional. Only return documents created before or on this date. $docTypes = ['doc_type', 'doc_type_2']; // Optional. You can get this values from getDocumentTypes() $search = 'some_file_name'; // Optional. Only return documents whose name or filename contains the search value. Partial matches allowed, no wildcards. $sortBy = 'name'; // Optional. One of: name or date $response = $client->listDocuments($userHandle, $privateKey, $page, $perPage, $sort, $startDate, $endDate, $docTypes, $search, $sortBy); // Response 200 echo $response->getStatusCode(); // 200 echo $response->getData()->success; // TRUE echo $response->getData()->status; // SUCCESS echo $response->getData()->documents; // An array of documents echo $response->getData()->documents[0]->user_handle; // The user handle that owns the document echo $response->getData()->documents[0]->document_id; // The document id echo $response->getData()->documents[0]->name; // The name of the document echo $response->getData()->documents[0]->filename; // The file name of the document echo $response->getData()->documents[0]->hash; // The hash of the file contents echo $response->getData()->documents[0]->type; // The document type echo $response->getData()->documents[0]->size; // The file size echo $response->getData()->documents[0]->created; // The datetime of creation echo $response->getData()->pagination->returned_count; // The amount of documents returned in this request echo $response->getData()->pagination->total_count; // The total amount of documents that meet the filters echo $response->getData()->pagination->current_page; // The current page of documents echo $response->getData()->pagination->total_pages; // The total amount of pages that meet the filters ``` ```csharp C# // userHandle is required // privateKey is required // All other parameters are optional List docTypes = new List { "" }; var response = api.ListDocuments(userHandle, privateKey, DateTime.Today, DateTime.Today.AddDays(1), docTypes, search, sortBy, page, perPage, order); // Success Object Response Console.WriteLine(response.StatusCode); // 200 var parsedResponse = (ListDocumentsResponse)response.Data; Console.WriteLine(parsedResponse.Success); Console.WriteLine(parsedResponse.Status); // SUCCESS Console.WriteLine(parsedResponse.Documents); // A list of documents Console.WriteLine(parsedResponse.Documents[0].DocumentId); Console.WriteLine(parsedResponse.Documents[0].UserHandle); Console.WriteLine(parsedResponse.Documents[0].Name); Console.WriteLine(parsedResponse.Documents[0].Filename); Console.WriteLine(parsedResponse.Documents[0].Hash); Console.WriteLine(parsedResponse.Documents[0].Type); Console.WriteLine(parsedResponse.Documents[0].Size); Console.WriteLine(parsedResponse.Documents[0].Created); Console.WriteLine(parsedResponse.Pagination); // Pagination information (CurrentPage, ReturnedCount, TotalPages, TotalCount) ``` ## Request Attributes [block:parameters] { "data": { "h-0": "Key", "h-1": "Type", "h-2": "Description", "0-0": "header", "0-1": "JSON object", "0-2": "Required. \n \nRequired keys: \n \n`created` - Unix epoch timestamp in seconds. Must not be future-dated and must not be dated more than 5 minutes in the past. \n`app_handle` - your app handle \n`user_handle` - the user_handle to pull docs for \n \nOptional keys: \n \n`reference`: Can be any value for your own reference. If not provided, one will be assigned. \n`version`: Cannot be null if key is present. Valid values: 0.2, v0.2, V0.2 ", "1-0": "start_date", "1-1": "string", "1-2": "Optional. \n \nYYYY-MM-DD \n \nOnly return documents created on or after this date.", "2-0": "end_date", "2-1": "string", "2-2": "Optional. \n \nYYYY-MM-DD \n \nOnly return documents created on or before this date.", "3-0": "doc_types", "3-1": "array of strings", "3-2": "Optional. \n \nUse the name value returned by [/document_types](https://docs.silamoney.com/docs/document_types). Full list of document types and mapping also found on that doc.", "4-0": "search", "4-1": "string", "4-2": "Optional. \n \nOnly return documents whose `name` or `filename` contains the `search` value. Partial matches allowed, no wildcards.", "5-0": "sort_by", "5-1": "string", "5-2": "Optional. \n \nAccepted values: \n`name` \n`date`" }, "cols": 3, "rows": 6, "align": [ "left", "left", "left" ] } [/block] *** # Responses | Status Code | `success` | Description | | :---------: | :-------: | :--------------------------------------------------------------- | | 200 | true | No errors encountered, but possible that no documents were found | | 400 | false | One or more invalid document types specified |

# See Also: * [/documents](/docs/documents) * [/get\_documents](/docs/get_documents) * [/document\_types](/docs/document_types)