Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

DEPRECATION NOTICE: The old URI https://api.onlinephotosubmission.com/api/photos[?][status=PENDING][&][offset=0][&][max=25] is now deprecated and will no longer be supported after January 1, 2023.

...

Optional Request Parameters:

  • status

    • Retrieves only photo 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

...

Code Block
languagejson
200 OK
[
        {
        "aspectRatioid": 1.01423442,
        "classificationsdateCreated": ["2022-09-01T16:43:47Z",
        "upVotes": 0,
  {        "width": 300,
        "iddateApproved": 557null,
         "externalURL": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m.jpg",
        "scorelastUpdated": 0.8875"2022-09-01T16:43:51Z",
        "helperBotReviewed": true,
        "requirementNameclassifications": "Helper[
Bot"            {
}         ],         "domainClassid": "com.campuscardtools.myphotoid.Photo"645261,
        "helperBotReviewed": true,         "idscore": 16990.9014,
        "isAspectRatioCorrect": true,
        "linksphotoRequirement": {
            "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/ct1ilj1mkb8iokq2mj95lahnjq80k49b1mhhc861o3k570qr05n2gcvad4nvdl6n.jpg"        "id": 125
 },              "lowestClassification": 0.8875, },
                "originalPhotorequirementName": { "HelperBot"
            }
   "id": 1698,    ],
        "publicKeyaspectRatio": "vjnnaolk42p47bc29l1mdhsjq7p6cb1m38inm5b09p6rt1rq33p2jiasph77e6u9"0.75,
            "linksheight": {400,
        "backgroundReplaced": true,
        "bytesdownVotes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/vjnnaolk42p47bc29l1mdhsjq7p6cb1m38inm5b09p6rt1rq33p2jiasph77e6u9.jpg"0,
        "automaticallyApprovedOrDenied": false,
  }         }"publicKey": "000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m",
        "personmanuallyEdited": {
 true,
          "idstatus": 942"PENDING",

           "usernamedomainClass": "john@company.comus.cloudcard.api.Photo",
        "version": 2,
        "emailperson": "john@company.com",{
            "identifierid": "647"57133436,
            "organizationusername": {...}"test_user@cloudcard.us",
            "additionalPhotosemail": ["test_user@cloudcard.us",
            "identifier": "54622347",
   {         "additionalPhotoRequired": true,
          "additionalPhotoType": {  "domainClass": "us.cloudcard.api.Person",
            "version": 363,
            "deleteOnDownloadadditionalPhotos": null,[
                {
       "enableCardholderCropping": null,            "id": 75755,
           "errors": {        "additionalPhotoType": {
                   "errors": []    "name": "Government issued ID",
                 },       "enableOcr": false,
                        "nameenableFacialRecognition": "Signature"false,
                        "notBoundenableGovIdClassifier": false,
                        "photoDimensionsgoodFacialRecognitionThreshold": {0.9,
                            "defaultMappedFieldsbadFacialRecognitionThreshold": [0.5
                    },
           "width",         "facialRecognitionScore": null,
                    "facialRecognitionClassification":  "heightunclassified",
                    "govIdScore": null,
          "description",          "govIdClassification": "unclassified",
                    "lowestClassification": "idunclassified",
                                "version""publicKey": "additional-photo-8.2022.237.rhtq56r50kimup2eeocqwocicmkeefdjf574oefip5i2l6k2nvqongb2c4kgnek1l",
                       "links": {
    ],                             "description"bytes": "180 60 (3:1)",https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-8.2022.237.rhtq56r50kimup2eeocqwocicmkeefdjf574oefip5i2l6k2nvqongb2c4kgnek1l.jpg"
                    }
       "errors": {        }
            ],
            "errorspreviouslyApprovedPhoto": []null,
            "customFields": {
              },  "message": "deliberately not rendered"
            }
        },
 "excludedFields": [        "lowestClassification": 0.9014,
               "isAspectRatioCorrect": true,
        "grailsApplicationlinks",: {
            "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m.jpg"
        },
        "springSecurityServiceoriginalPhoto",: {
            "id": 1415399,
                 "messageSource""publicKey": "000008.22.244.uurg0fq3npg8g4kcti2r7nsfs45spqp4poisgl63fos1hhou437ldllep54adau9hs2j5dd9amq6v47p",
            "links": {
              ],  "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.uurg0fq3npg8g4kcti2r7nsfs45spqp4poisgl63fos1hhou437ldllep54adau9hs2j5dd9amq6v47p.jpg"
            },
            "heightdateCreated": 60,
   "2022-09-01T16:43:36Z"
           },
            "idpersonHasApprovedPhoto": null,false
    },
              {
        "longSideid": 1801415398,
        "dateCreated": "2022-09-01T16:43:05Z",
        "upVotes": 0,
        "shortSidewidth": 60300,
        "dateApproved": null,
          "externalURL": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52.jpg",
        "valuelastUpdated": 3.0"2022-09-01T16:43:07Z",
        "helperBotReviewed": true,
        "classifications": [
        "version": null,   {
                "id": 645260,
        "width": 180       "score": 0.6342,
                },
"photoRequirement": {
                       "promptid": "Sign125
the paper, dude!",              },
          "required": true     "requirementName": "HelperBot"
              },
        ],
           "domainClassaspectRatio": "com.campuscardtools.myphotoid.AdditionalPhoto"0.7481296758104738,
          "height": 401,
         "idbackgroundReplaced": 76true,
        "downVotes": 0,
        "automaticallyApprovedOrDenied": false,
        "linkspublicKey": {"000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52",
        "manuallyEdited": true,
        "status": "PENDING",
        "bytesdomainClass": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-kshctuu4cio5si57oarqsih2ghn6t970vtpsmbcqlpq21aljl9lce301qcqdqtas.jpg"us.cloudcard.api.Photo",
        "version": 1,
        "person": {
},                     "person"id": {577122,
            "username": "test_user2@cloudcard.us",
            "dirtyPasswordEncodedemail": false"test_user2@cloudcard.us",
             "identifier": "123232323",
            "usernameadditionalPhotoRequired": "tony+wje@sharptop.co"true,
            "domainClass": "us.cloudcard.api.Person",
            "emailversion": "tony+wje@sharptop.co"13,
            "additionalPhotos": [
           "password": "$2a$10$/nZFbCh84V1hhQijf9PtkeY7q5LXlfhSB/NCL9jT7XRIXnJrT2D4a",    {
                    "identifierid": "647"75753,
                        "activatedDateadditionalPhotoType": null,{
                        "unsubscribename": false"Government issued ID",
                        "enabledenableOcr": truefalse,
                        "accountExpiredenableFacialRecognition": false,
                        "accountLockedenableGovIdClassifier": false,
                        "passwordExpiredgoodFacialRecognitionThreshold": false0.9,
                        "passwordResetRequiredbadFacialRecognitionThreshold": false,0.5
                        "additionalPhotoRequired": true,
 },
                      "dateTermsAcceptedfacialRecognitionScore": "2020-10-05T19:25:57Z"null,
                        "dateCreated""facialRecognitionClassification": "2020-09-01T15:29:10Zunclassified",
  
                     "lastUpdatedgovIdScore": "2020-10-15T13:19:52Z",
null,
                       "dateArchivedgovIdClassification": null"unclassified",
 
                      "preArchiveEmaillowestClassification": null"unclassified",
                        "preArchiveUsernamepublicKey": null,
   "additional-photo-8.2022.228.duesuml0bahqp0losds5onkudij4f3j54e2v15s4coje43irqt1ekm27bkcg6a0a",
                    "preArchiveIdentifierlinks": null,{
                        "idbytes": 942,"https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-8.2022.228.duesuml0bahqp0losds5onkudij4f3j54e2v15s4coje43irqt1ekm27bkcg6a0a.jpg"
                    }
    "version": 9           }
         }   ],
            "previouslyApprovedPhoto": }null,
                "customFields": {
                    "additionalPhotoTypemessage": {"deliberately not rendered"
            }
         "deleteOnDownload": null},
           "lowestClassification": 0.6342,
            "enableCardholderCroppingisAspectRatioCorrect": nulltrue,
  
                     "errors"links": {
                            "errors": []
                        },
                        "name": "Government ID",
                        "notBound": false,
                        "photoDimensions": {
                            "defaultMappedFields": [
                                "width",
                                "height",
                                "description",
                                "id",
                                "version"
                            ],
                            "description": null,
                            "errors": {
                                "errors": []
                            },
                            "excludedFields": [
                                "grailsApplication",
                                "springSecurityService",
                                "messageSource"
                            ],
                            "height": 720,
                            "id": null,
                            "longSide": 720,
                            "shortSide": 720,
                            "value": 1.0,
                            "version": null,
                            "width": 720
                        },
                        "prompt": "Please submit a photo of your government issued ID card, i.e. driver's license or passport.",
                        "required": true
                    },
                    "domainClass": "com.campuscardtools.myphotoid.AdditionalPhoto",
                    "id": 77,
                    "links": {
                        "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-jvdhaqm5enj9uqjpi5v98uu3s3ht3j7n99nb5al926fmn8p2tlapfngpqks9sb0h.jpg"
                    },
                    "person": {
                        "dirtyPasswordEncoded": false,
                        "username": "tony+wje@sharptop.co",
                        "email": "tony+wje@sharptop.co",
                        "password": "$2a$10$/nZFbCh84V1hhQijf9PtkeY7q5LXlfhSB/NCL9jT7XRIXnJrT2D4a",
                        "identifier": "647",
                        "activatedDate": null,
                        "unsubscribe": false,
                        "enabled": true,
                        "accountExpired": false,
                        "accountLocked": false,
                        "passwordExpired": false,
                        "passwordResetRequired": false,
                        "additionalPhotoRequired": true,
                        "dateTermsAccepted": "2020-10-05T19:25:57Z",
                        "dateCreated": "2020-09-01T15:29:10Z",
                        "lastUpdated": "2020-10-15T13:19:52Z",
                        "dateArchived": null,
                        "preArchiveEmail": null,
                        "preArchiveUsername": null,
                        "preArchiveIdentifier": null,
                        "id": 942,
                        "version": 9
                    }
                }
            ],
            "additionalPhotoRequired": true,
            "previouslyApprovedPhoto": null
        },
        "personHasApprovedPhoto": false,
        "publicKey": "ct1ilj1mkb8iokq2mj95lahnjq80k49b1mhhc861o3k570qr05n2gcvad4nvdl6n",
        "status": "PENDING",
        "version": 3
    },
    {
        "aspectRatio": 1.0,
        "classifications": [
            {
                "id": 556,
                "score": 0.963,
                "requirementName": "Helper Bot"
            }
        ],
        "domainClass": "com.campuscardtools.myphotoid.Photo",
        "helperBotReviewed": true,
        "id": 1697,
        "isAspectRatioCorrect": true,
        "links": {
            "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/jti0njqc66nor0n2reo4vgu6tql6kl2ok2hs1ipehjjv35k0nca987mlht8iebsr.jpg"
        },
        "lowestClassification": 0.963,
        "originalPhoto": {
            "id": 1696,
            "publicKey": "ki8g3gbrc9sdt6sqnmc1roob37hiru0ans95su1suue5usvbgm42aen0kqigc0jc",
            "links": {
                "bytes": "https:"bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/ki8g3gbrc9sdt6sqnmc1roob37hiru0ans95su1suue5usvbgm42aen0kqigc0jc.jpg"
            }
        },
        "person": {
            "id": 1,000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52.jpg"
             "username": "a"},
            "emailoriginalPhoto": "a@foo.edu",{
            "identifierid": "1"1415392,
            "organizationpublicKey": {"000008.22.244.}838chgibdt968sol6clatctdtnutmrin40o112gt4d8qisald0olj7mho2pqulcem1mjsff30b11ih50",
            "additionalPhotoslinks": [],{
            "additionalPhotoRequired": false,             "previouslyApprovedPhotobytes": null"https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.838chgibdt968sol6clatctdtnutmrin40o112gt4d8qisald0olj7mho2pqulcem1mjsff30b11ih50.jpg"
        },    },
    "personHasApprovedPhoto": false,         "publicKeydateCreated": "jti0njqc66nor0n2reo4vgu6tql6kl2ok2hs1ipehjjv35k0nca987mlht8iebsr",2022-09-01T16:42:36Z"
        "status": "PENDING"},
        "versionpersonHasApprovedPhoto": 2false
    }
]