Get a Photo

URI: https://api.cloudcard.us/photo/{photo.id}
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
Description: Returns a photo
Example HTTP Request Body

(LEAVE REQUEST BODY EMPTY)
Example Response

{
    "id": 99999,
    "dateCreated": "2024-04-08T18:51:33Z",
    "upVotes": 0,
    "helperBotAction": "AUTO_APPROVE",
    "width": 300,
    "dateApproved": "2024-04-08T19:22:23Z",
    "externalURL": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000000.25.099.wlE1lYgZ1gaIxpGBYpNBiaw9YGTBCqsB6DEDUKD75G3ywGMLjnHNEkzifrTBW0CAEhIQrKa2f5ShTFva.jpg",
    "lastUpdated": "2024-04-08T18:57:05Z",
    "helperBotReviewed": false,
    "processingMode": null,
    "aspectRatio": 0.7481296758104738,
    "height": 401,
    "backgroundReplaced": true,
    "downVotes": 0,
    "automaticallyApprovedOrDenied": false,
    "publicKey": "000000.25.099.wlE1lYgZ1gaIxpGBYpNBiaw9YGTBCqsB6DEDUKD75G3ywGMLjnHNEkzifrTBW0CAEhIQrKa2f5ShTFva",
    "manuallyEdited": false,
    "status": "DENIED",
    "domainClass": "us.cloudcard.api.Photo",
    "person": {
        "id": 123,
        "dateCreated": "2024-04-08T18:50:48Z",
        "passwordResetRequired": false,
        "organization": {
            "id": 1,
            "photoSubmissionMode": "CAPTURE_OR_UPLOAD",
            "officeLogoutUrl": "https://help.remotephoto.ai/",
            "isPaid": true,
            "downloadLabel": "Download Photos",
            "allowAutoCrop": true,
            "idealHeadTop": 0.1,
            "logoutUrl": "https://help.remotephoto.ai/",
            "allowAutoRotate": true,
            "allowAutoDenial": true,
            "padCharacter": null,
            "allowPasswordAuthenticationForStaff": true,
            "allowDeprecatedEndpoints": false,
            "maxNumberOfInvitations": 0,
            "photoDimensions": {
                "id": 6,
                "width": 300,
                "height": 300,
                "description": "300:300 (1:1)",
                "domainClass": "us.cloudcard.api.PhotoDimensions",
                "version": 0,
                "value": 1.0,
                "longSide": 300,
                "shortSide": 300
            },
            "allowPasswordAuthenticationForService": false,
            "name": "RemotePhoto",
            "badPhotoThreshold": 0.4,
            "managerApproveOwnPhoto": false,
            "helpScoutBeacons": [
                {
                    "id": 18,
                    "helpScoutId": "3123456d-1230-123d-123f-cfasdfqwerqc9",
                    "organization": {
                        "id": 1
                    },
                    "icon": "fa fa-question-circle",
                    "role": {
                        "id": 2,
                        "authority": "ROLE_OFFICE",
                        "domainClass": "us.cloudcard.api.Role",
                        "version": 0
                    },
                    "name": "Office Knowledge Base",
                    "version": 0
                }
            ],
            "allowAutoBackgroundReplacement": true,
            "sendEmailFrom": "My Card Office <noreply@remotephoto.ai>",
            "identifier": "RemotePhoto",
            "emailReplyTo": "My Card Office <cardoffice@myschool.edu>",
            "expirationDate": null,
            "backgroundColor": null,
            "approvalsPerDay": null,
            "parent": null,
            "allowAutoApproval": true,
            "termsOfService": null,
            "cardholderInactivityLogoutInterval": 3600000,
            "siteURL": "",
            "requireMultifactorAuthentication": true,
            "minIdentifierLength": null,
            "allowPasswordAuthenticationForCardholders": false,
            "autoArchiveAction": null,
            "lastUpdated": "2025-02-06T18:55:06Z",
            "daysBetweenInvitations": 1,
            "backgroundImage": null,
            "sendAutomaticFeedback": false,
            "usePersonIdentifier": true,
            "emailDomains": [],
            "autoArchiveStatus": null,
            "allowUnconstrainedCropping": false,
            "additionalPhotoTypes": [
                {
                    "id": 1236,
                    "timeToLive": 86400000,
                    "enableOcr": true,
                    "organization": {
                        "id": 1
                    },
                    "enableGovIdClassifier": true,
                    "enableFacialRecognition": true,
                    "goodFacialRecognitionThreshold": 0.95,
                    "enableCardholderCropping": false,
                    "denialReasonText": "You forgot to upload a Government issued ID",
                    "submissionMode": "UPLOAD",
                    "autoApprovalMode": "NEVER_ALLOWED",
                    "badFacialRecognitionThreshold": 0.8,
                    "prompt": "Submit a photo of your government ID",
                    "deleteOnDownload": true,
                    "name": "Government ID",
                    "required": true,
                    "version": 23,
                    "domainClass": "us.cloudcard.api.AdditionalPhotoType",
                    "photoDimensions": {
                        "id": 20,
                        "width": 200,
                        "height": 67,
                        "description": "200:67 ~(3:1)",
                        "domainClass": "us.cloudcard.api.PhotoDimensions",
                        "version": 0,
                        "value": 2.9850746269,
                        "longSide": 200,
                        "shortSide": 67
                    },
                    "ocrRequirementsMap": {
                        "Card Delivery": false,
                        "Last name": false
                    }
                }
            ],
            "defaultGroup": {
                "id": 1,
                "enableAutoIdentifier": false,
                "apiLinkMinutesToLive": 60,
                "organization": {
                    "id": 1
                },
                "apiLinkUses": 1,
                "receivableEmails": "login,approval,denial",
                "emailLinkMinutesToLive": 129600,
                "identifierPrefix": null,
                "emailLinkUses": null,
                "name": "Cardholder",
                "daysBetweenManagerReminders": 7,
                "domainClass": "us.cloudcard.api.CardholderGroup",
                "version": 3
            },
            "goodPhotoThreshold": 0.7,
            "personIdentifierLabel": "ID Number",
            "minPhotoResolution": 0.25,
            "defaultTheme": null,
            "preventMultiplePhotos": false,
            "logoutWarningInterval": 30000,
            "themes": [],
            "idealHeadSize": 0.6,
            "customCssUrl": "",
            "aiOptOut": false,
            "useEmailAsUsername": true,
            "officeUserInactivityLogoutInterval": 43200000,
            "helperBotDelay": 1000,
            "domainClass": "us.cloudcard.api.Organization",
            "downloadStrategy": {
                "id": "ZIP_DOWNLOADED",
                "name": "Zip File"
            },
            "approvalsMadeToday": 0,
            "backgroundReplacementEnabled": true,
            "canApproveMorePhotosToday": true,
            "customFields": [
                {
                    "id": 100000,
                    "lastUpdated": "2023-10-09T14:11:58Z",
                    "allowUserInput": true,
                    "showInList": false,
                    "denialReasonText": "You need to specify how you want to receive your card.",
                    "requireDropdownForStaff": false,
                    "sortOrder": 0,
                    "prompt": "How would you like to receive your card?",
                    "name": "Card Delivery",
                    "requireUserInput": false,
                    "domainClass": "us.cloudcard.api.CustomField",
                    "version": 4
                }
            ],
            "photoRequirements": [
                {
                    "id": 20,
                    "listIndex": 0,
                    "lastUpdated": "2023-08-11T18:45:59Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "Crop",
                    "preventDeletion": true,
                    "hidden": false,
                    "photoRequirementTypes": [
                        {
                            "id": 123,
                            "dateCreated": "2022-08-31T14:01:42Z",
                            "lastUpdated": "2022-08-31T14:01:42Z",
                            "name": "Cropping"
                        }
                    ],
                    "requirement": "Should be cropped slightly above head to middle of chest",
                    "version": 10,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                },
                {
                    "id": 21,
                    "listIndex": 1,
                    "lastUpdated": "2022-10-07T14:08:41Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "Plain Background",
                    "preventDeletion": true,
                    "hidden": false,
                    "photoRequirementTypes": [
                        {
                            "id": 1,
                            "dateCreated": "2022-08-31T14:01:39Z",
                            "lastUpdated": "2022-08-31T14:01:39Z",
                            "name": "Plain Background"
                        }
                    ],
                    "requirement": "Should be taken against a plain, light background",
                    "version": 2,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                },
                {
                    "id": 22,
                    "listIndex": 2,
                    "lastUpdated": "2022-10-07T14:08:41Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "Color Photo",
                    "preventDeletion": true,
                    "hidden": false,
                    "photoRequirementTypes": [
                        {
                            "id": 6,
                            "dateCreated": "2022-08-31T14:01:41Z",
                            "lastUpdated": "2022-08-31T14:01:41Z",
                            "name": "Color Photo"
                        }
                    ],
                    "requirement": "Must be a color photo.",
                    "version": 3,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                },
                {
                    "id": 23,
                    "listIndex": 3,
                    "lastUpdated": "2023-04-04T14:27:11Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "No Accessories",
                    "preventDeletion": true,
                    "hidden": false,
                    "photoRequirementTypes": [
                        {
                            "id": 12,
                            "dateCreated": "2022-08-31T14:01:43Z",
                            "lastUpdated": "2022-08-31T14:01:43Z",
                            "name": "Hat or Sunglasses"
                        }
                    ],
                    "requirement": "Must not include sunglasses or hat",
                    "version": 3,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                },
                {
                    "id": 24,
                    "listIndex": 4,
                    "lastUpdated": "2022-10-10T18:24:41Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "Face Camera",
                    "preventDeletion": true,
                    "hidden": false,
                    "photoRequirementTypes": [
                        {
                            "id": 2,
                            "dateCreated": "2022-08-31T14:01:39Z",
                            "lastUpdated": "2022-08-31T14:01:39Z",
                            "name": "Head/Body Position"
                        }
                    ],
                    "requirement": "Must be positioned directly facing the camera",
                    "version": 1,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                },
                {
                    "id": 25,
                    "listIndex": 5,
                    "lastUpdated": "2023-04-04T14:27:25Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "Look At Camera",
                    "preventDeletion": true,
                    "hidden": false,
                    "photoRequirementTypes": [
                        {
                            "id": 15,
                            "dateCreated": "2022-08-31T14:01:45Z",
                            "lastUpdated": "2022-08-31T14:01:45Z",
                            "name": "Eyes Closed"
                        }
                    ],
                    "requirement": "Eyes should be open and looking at the camera",
                    "version": 3,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                },
                {
                    "id": 103055,
                    "listIndex": 8,
                    "lastUpdated": "2024-12-17T21:10:14Z",
                    "organization": {
                        "id": 123
                    },
                    "uniqueName": "HelperBot 2.1 BG Removed",
                    "preventDeletion": true,
                    "hidden": true,
                    "photoRequirementTypes": [
                        {
                            "id": 22,
                            "dateCreated": "2022-10-06T16:26:36Z",
                            "lastUpdated": "2022-10-06T16:26:36Z",
                            "name": "Bot"
                        }
                    ],
                    "requirement": "It should look like a photo that would be acceptable on a passport or driver's license",
                    "version": 2,
                    "domainClass": "us.cloudcard.api.PhotoRequirement"
                }
            ],
            "locale": "en"
        },
        "preArchiveEmail": null,
        "accountExpired": false,
        "dateArchived": null,
        "unsubscribe": false,
        "identifier": null,
        "preArchiveIdentifier": null,
        "dateTermsAccepted": "2024-04-08T18:51:14Z",
        "passwordExpired": false,
        "lastUpdated": "2024-04-08T18:51:14Z",
        "cardholderGroup": {
            "id": 1
        },
        "additionalPhotoRequired": true,
        "quicksightArn": null,
        "preArchiveUsername": null,
        "username": "exampleUser@remotephoto.ai",
        "accountLocked": false,
        "activatedDate": null,
        "aiOptOut": false,
        "enabled": true,
        "email": "exampleUser@remotephoto.ai",
        "additionalPhotos": []
    },
    "classifications": [
        {
            "id": 63246658,
            "score": 0.9292,
            "photo": {
                "id": 63734457
            },
            "reverseScore": false,
            "photoRequirement": null,
            "recommendedAction": null,
            "message": null,
            "classifier": {
                "id": 1,
                "dateCreated": "2024-12-18T01:47:11Z",
                "lastUpdated": "2024-12-18T01:47:11Z",
                "active": true,
                "classifierType": "LEGACY",
                "displayName": "Approvable ID Photo HB.17.02",
                "name": "generic"
            },
            "label": {
                "id": 3,
                "dateCreated": "2024-12-18T01:55:16Z",
                "lastUpdated": "2024-12-18T01:55:16Z",
                "negatedName": "Not generic",
                "name": "generic"
            },
            "version": 1,
            "domainClass": "us.cloudcard.api.Classification"
        },
        {
            "id": 63246646,
            "score": 0.460298,
            "photo": {
                "id": 63734457
            },
            "reverseScore": false,
            "photoRequirement": null,
            "recommendedAction": null,
            "message": null,
            "classifier": {
                "id": 123,
                "dateCreated": "2024-12-18T14:57:40Z",
                "lastUpdated": "2024-12-18T14:57:40Z",
                "active": true,
                "classifierType": "FACE_DATA",
                "displayName": "Face Data",
                "name": "Face Data"
            },
            "label": {
                "id": 18,
                "dateCreated": "2024-12-18T14:57:47Z",
                "lastUpdated": "2024-12-18T14:57:47Z",
                "negatedName": "Blurry",
                "name": "Sharp/Clear"
            },
            "version": 1,
            "domainClass": "us.cloudcard.api.Classification"
        },
        {
            "id": 63246637,
            "score": 0.999707,
            "photo": {
                "id": 63734457
            },
            "reverseScore": false,
            "photoRequirement": null,
            "recommendedAction": null,
            "message": null,
            "classifier": {
                "id": 123,
                "dateCreated": "2024-12-18T14:57:40Z",
                "lastUpdated": "2024-12-18T14:57:40Z",
                "active": true,
                "classifierType": "FACE_DATA",
                "displayName": "Face Data",
                "name": "Face Data"
            },
            "label": {
                "id": 9,
                "dateCreated": "2024-12-18T14:57:47Z",
                "lastUpdated": "2024-12-18T14:57:47Z",
                "negatedName": "No Eyeglasses",
                "name": "Eyeglasses"
            },
            "version": 1,
            "domainClass": "us.cloudcard.api.Classification"
        },
        {
            "id": 63246638,
            "score": 5.96046E-6,
            "photo": {
                "id": 63734457
            },
            "reverseScore": false,
            "photoRequirement": null,
            "recommendedAction": null,
            "message": null,
            "classifier": {
                "id": 123,
                "dateCreated": "2024-12-18T14:57:40Z",
                "lastUpdated": "2024-12-18T14:57:40Z",
                "active": true,
                "classifierType": "FACE_DATA",
                "displayName": "Face Data",
                "name": "Face Data"
            },
            "label": {
                "id": 10,
                "dateCreated": "2024-12-18T14:57:47Z",
                "lastUpdated": "2024-12-18T14:57:47Z",
                "negatedName": "No Sunglasses",
                "name": "Sunglasses"
            },
            "version": 1,
            "domainClass": "us.cloudcard.api.Classification"
        },
        {
            "id": 63246645,
            "score": 0.721085,
            "photo": {
                "id": 63734457
            },
            "reverseScore": false,
            "photoRequirement": null,
            "recommendedAction": null,
            "message": null,
            "classifier": {
                "id": 123,
                "dateCreated": "2024-12-18T14:57:40Z",
                "lastUpdated": "2024-12-18T14:57:40Z",
                "active": true,
                "classifierType": "FACE_DATA",
                "displayName": "Face Data",
                "name": "Face Data"
            },
            "label": {
                "id": 17,
                "dateCreated": "2024-12-18T14:57:47Z",
                "lastUpdated": "2024-12-18T14:57:47Z",
                "negatedName": "Poor Lighting/Dark",
                "name": "Bright"
            },
            "version": 1,
            "domainClass": "us.cloudcard.api.Classification"
        }
    ],    
    "lowestClassification": 0.5,
    "isAspectRatioCorrect": true,
    "links": {
        "bytes": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000000.25.099.wlE1lYgZ1gaIxpGBYpNBiaw9YGTBCqsB6DEDUKD75G3ywGMLjnHNEkzifrTBW0CAEhIQrKa2f5ShTFva.jpg"
    },
    "originalPhoto": {
        "id": 9642749,
        "publicKey": "000000.25.099.17543059499227279982652705456159922043545350466530045655938314590555064610431400",
        "links": {
            "bytes": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000000.25.099.17543059499227279982652705456159922043545350466530045655938314590555064610431400.jpg"
        }
    },
    "personHasApprovedPhoto": false,
    "version": 5,
    "onHoldReasons": [],
    "isHelperBotProcessing": false
}
CloudCard Docs

Get a Photo

Analytics

Example HTTP Request Body

Example Response

Related content
