Get Photo List

Update: As of version 25.02.03, this endpoint now returns an empty classifications list for each photo in the response due to the large number of classifications photos can have. If a photo’s classifications are needed, get the photo directly: Get a Photo

URI: https://api.cloudcard.us/photo[?][status=PENDING][&][offset=0][&][max=25]

HTTP Method: GET

Optional Request Parameters:

status
- Retrieves only photos in the designated status
- Allowable Values:
  - PENDING
  - APPROVED
  - DENIED
  - READY_FOR_DOWNLOAD
  - DOWNLOADED
  - DONE
  - ENROUTE
offset
- Allows pagination. Skips the number of photos designated.
- Default Value: 0
- Allowable Values: any integer greater than or equal to 0
max
- Allows pagination. Limits the number of photos retrieved.
- Default Value: 25
- Allowable Values: any integer between 0 and 1000

Required Headers: X-Auth-Token (see: Authentication)

Description: Returns up to max photos with given status, if specified. If the organization has more than max photos of the given status, use the offsetparameter to page through the results. Each item in the list is a lightweight representation of a photo for faster processing of large lists. For a more comprehensive response, photos can be retrieved individually by calling Get a Photo.

Example HTTP Request Body

{EMPTY}

Example Response

200 OK
[
        {
        "id": 1423442,
        "dateCreated": "2022-09-01T16:43:47Z",
        "upVotes": 0,
        "width": 300,
        "dateApproved": null,
        "externalURL": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m.jpg",
        "lastUpdated": "2022-09-01T16:43:51Z",
        "helperBotReviewed": true,
        "aspectRatio": 0.75,
        "height": 400,
        "backgroundReplaced": true,
        "downVotes": 0,
        "automaticallyApprovedOrDenied": false,
        "publicKey": "000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m",
        "manuallyEdited": true,
        "status": "PENDING",
        "domainClass": "us.cloudcard.api.Photo",
        "version": 2,
        "person": {
            "id": 57133436,
            "username": "test_user@cloudcard.us",
            "email": "test_user@cloudcard.us",
            "identifier": "54622347",
            "additionalPhotoRequired": true,
            "domainClass": "us.cloudcard.api.Person",
            "version": 363,
            "additionalPhotos": [
                {
                    "id": 75755,
                    "additionalPhotoType": {
                        "name": "Government issued ID",
                        "enableOcr": false,
                        "enableFacialRecognition": false,
                        "enableGovIdClassifier": false,
                        "goodFacialRecognitionThreshold": 0.9,
                        "badFacialRecognitionThreshold": 0.5
                    },
                    "facialRecognitionScore": null,
                    "facialRecognitionClassification": "unclassified",
                    "govIdScore": null,
                    "govIdClassification": "unclassified",
                    "lowestClassification": "unclassified",
                    "publicKey": "additional-photo-8.2022.237.rhtq56r50kimup2eeocqwocicmkeefdjf574oefip5i2l6k2nvqongb2c4kgnek1l",
                    "links": {
                        "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-8.2022.237.rhtq56r50kimup2eeocqwocicmkeefdjf574oefip5i2l6k2nvqongb2c4kgnek1l.jpg"
                    }
                }
            ],
            "previouslyApprovedPhoto": null,
            "customFields": {
                "message": "deliberately not rendered"
            }
        },
        "lowestClassification": 0.9014,
        "isAspectRatioCorrect": true,
        "links": {
            "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m.jpg"
        },
        "originalPhoto": {
            "id": 1415399,
            "publicKey": "000008.22.244.uurg0fq3npg8g4kcti2r7nsfs45spqp4poisgl63fos1hhou437ldllep54adau9hs2j5dd9amq6v47p",
            "links": {
                "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.uurg0fq3npg8g4kcti2r7nsfs45spqp4poisgl63fos1hhou437ldllep54adau9hs2j5dd9amq6v47p.jpg"
            },
            "dateCreated": "2022-09-01T16:43:36Z"
        },
        "personHasApprovedPhoto": false,
        "onHoldReasons": {
            "message": "deliberately not rendered"
        },
        "isHelperBotProcessing": false,
        "classifications": []
    },
    {
        "id": 1415398,
        "dateCreated": "2022-09-01T16:43:05Z",
        "upVotes": 0,
        "width": 300,
        "dateApproved": null,
        "externalURL": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52.jpg",
        "lastUpdated": "2022-09-01T16:43:07Z",
        "helperBotReviewed": true,
        "aspectRatio": 0.7481296758104738,
        "height": 401,
        "backgroundReplaced": true,
        "downVotes": 0,
        "automaticallyApprovedOrDenied": false,
        "publicKey": "000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52",
        "manuallyEdited": true,
        "status": "PENDING",
        "domainClass": "us.cloudcard.api.Photo",
        "version": 1,
        "person": {
            "id": 577122,
            "username": "test_user2@cloudcard.us",
            "email": "test_user2@cloudcard.us",
            "identifier": "123232323",
            "additionalPhotoRequired": true,
            "domainClass": "us.cloudcard.api.Person",
            "version": 13,
            "additionalPhotos": [
                {
                    "id": 75753,
                    "additionalPhotoType": {
                        "name": "Government issued ID",
                        "enableOcr": false,
                        "enableFacialRecognition": false,
                        "enableGovIdClassifier": false,
                        "goodFacialRecognitionThreshold": 0.9,
                        "badFacialRecognitionThreshold": 0.5
                    },
                    "facialRecognitionScore": null,
                    "facialRecognitionClassification": "unclassified",
                    "govIdScore": null,
                    "govIdClassification": "unclassified",
                    "lowestClassification": "unclassified",
                    "publicKey": "additional-photo-8.2022.228.duesuml0bahqp0losds5onkudij4f3j54e2v15s4coje43irqt1ekm27bkcg6a0a",
                    "links": {
                        "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-8.2022.228.duesuml0bahqp0losds5onkudij4f3j54e2v15s4coje43irqt1ekm27bkcg6a0a.jpg"
                    }
                }
            ],
            "previouslyApprovedPhoto": null,
            "customFields": {
                "message": "deliberately not rendered"
            }
        },
        "lowestClassification": 0.6342,
        "isAspectRatioCorrect": true,
        "links": {
            "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52.jpg"
        },
        "originalPhoto": {
            "id": 1415392,
            "publicKey": "000008.22.244.838chgibdt968sol6clatctdtnutmrin40o112gt4d8qisald0olj7mho2pqulcem1mjsff30b11ih50",
            "links": {
                "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.838chgibdt968sol6clatctdtnutmrin40o112gt4d8qisald0olj7mho2pqulcem1mjsff30b11ih50.jpg"
            },
            "dateCreated": "2022-09-01T16:42:36Z"
        },
        "personHasApprovedPhoto": false,
        "onHoldReasons": {
            "message": "deliberately not rendered"
        },
        "isHelperBotProcessing": false,
        "classifications": []
    }
]

CloudCard Docs

Get Photo List

Analytics

Example HTTP Request Body

Example Response

Related content