Skip to main content
GET
/
v2
/
user-uploads
List all user uploads
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/user-uploads \
  --header 'Authorization: Basic <encoded-value>'
{
  "results": [
    {
      "id": "01320596-2c3d-189c-53e7-a8ce6d625b33",
      "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
      "document_type": "proof-of-identity",
      "file_url": "www.argyle.com/storagename",
      "file_name": "my_drivers_license.pdf",
      "metadata": {
        "employment": null,
        "ocr_data": null,
        "ocr_authenticity": null,
        "ocr_authenticity_score": null
      },
      "processing": {
        "classification": "unauthorized",
        "ocr": "unauthorized",
        "authenticity": "unauthorized"
      },
      "created_at": "2024-07-08T13:43:49.864Z",
      "updated_at": "2024-07-08T13:43:51.868Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

account
string<uuid>

Filter by account ID.

user
string<uuid>

Filter by user ID.

document_type
string<uuid>

Filter by document_type.

limit
integer

Number of user upload objects returned per page. Default: 10. Maximum: 200.

cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json

A paginated list of user upload objects.

results
object[]
required
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.