Versions Compared

Key

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

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

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.

HTTP Method: GET

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,
 {                 "id"width": 557300,
  
             "scoredateApproved": 0.8875null,
                "requirementName"externalURL": "Helper Bot"https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m.jpg",
        "lastUpdated": "2022-09-01T16:43:51Z",
  }         ]"helperBotReviewed": true,
        "domainClassclassifications": "com.campuscardtools.myphotoid.Photo",[
        "helperBotReviewed": true,   {
     "id": 1699,           "isAspectRatioCorrectid": true,
     645261,
  "links": {             "bytesscore": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/ct1ilj1mkb8iokq2mj95lahnjq80k49b1mhhc861o3k570qr05n2gcvad4nvdl6n.jpg"0.9014,
        },
        "lowestClassificationphotoRequirement": 0.8875,{
        "originalPhoto": {
            "id": 125
1698,             "publicKey": "vjnnaolk42p47bc29l1mdhsjq7p6cb1m38inm5b09p6rt1rq33p2jiasph77e6u9",
            "links": {  },
                "bytesrequirementName": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/vjnnaolk42p47bc29l1mdhsjq7p6cb1m38inm5b09p6rt1rq33p2jiasph77e6u9.jpgHelperBot"
            }
        }],
        "personaspectRatio": {
 0.75,
          "idheight": 942400,
            "username": "john@company.com""backgroundReplaced": true,
            "emaildownVotes": "john@company.com",
   0,
        "identifierautomaticallyApprovedOrDenied": "647"false,
 
          "organizationpublicKey": {"000008.22.244.}929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m",
            "additionalPhotosmanuallyEdited": [true,
        "status": "PENDING",
      {    "domainClass": "us.cloudcard.api.Photo",
        "version": 2,
        "additionalPhotoTypeperson": {
            "id": 57133436,
            "deleteOnDownloadusername": null"test_user@cloudcard.us",
            "email": "test_user@cloudcard.us",
            "enableCardholderCroppingidentifier": null"54622347",
            "additionalPhotoRequired": true,
            "errorsdomainClass": {
"us.cloudcard.api.Person",
            "version": 363,
             "errorsadditionalPhotos": []
                {
                },    "id": 75755,
                    "nameadditionalPhotoType": "Signature",{
                        "notBoundname": false"Government issued ID",
                        "photoDimensionsenableOcr": {false,
                            "defaultMappedFieldsenableFacialRecognition": [false,
                          "enableGovIdClassifier": false,
     "width",                   "goodFacialRecognitionThreshold": 0.9,
             "height",           "badFacialRecognitionThreshold": 0.5
                    "description"},
                    "facialRecognitionScore": null,
          "id",          "facialRecognitionClassification": "unclassified",
                     "versiongovIdScore": null,
                    "govIdClassification": "unclassified",
     ],                             "description": "180 60 (3:1)",
"lowestClassification": "unclassified",
                           "errors"publicKey": {
"additional-photo-8.2022.237.rhtq56r50kimup2eeocqwocicmkeefdjf574oefip5i2l6k2nvqongb2c4kgnek1l",
                               "errors"links": []{
                            },"bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-8.2022.237.rhtq56r50kimup2eeocqwocicmkeefdjf574oefip5i2l6k2nvqongb2c4kgnek1l.jpg"
                    }
         "excludedFields": [      }
            ],
             "grailsApplicationpreviouslyApprovedPhoto": null,
            "customFields": {
                  "springSecurityServicemessage",: "deliberately not rendered"
            }
        },
        "messageSourcelowestClassification": 0.9014,
        "isAspectRatioCorrect": true,
        "links": {
       ],     "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.929kldt4jgd6b4q3lgmkb8v7mf7dtfrl0aha1bmaq2uj2hasdfe96jil234dvrh2sfvftiglmgdf75m.jpg"
        },
             "heightoriginalPhoto": 60,{
            "id": 1415399,
              "idpublicKey": null,"000008.22.244.uurg0fq3npg8g4kcti2r7nsfs45spqp4poisgl63fos1hhou437ldllep54adau9hs2j5dd9amq6v47p",
            "links": {
                "longSidebytes": 180,"https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.uurg0fq3npg8g4kcti2r7nsfs45spqp4poisgl63fos1hhou437ldllep54adau9hs2j5dd9amq6v47p.jpg"
            },
               "shortSidedateCreated": 60,
 "2022-09-01T16:43:36Z"
                 },
        "valuepersonHasApprovedPhoto": 3.0,false
    },
        {
              "version"id": null1415398,
        "dateCreated": "2022-09-01T16:43:05Z",
        "upVotes": 0,
        "width": 180300,
        "dateApproved": null,
              },
                        "prompt": "Sign the paper, dude!",
                        "required": true
                    },
                    "domainClass": "com.campuscardtools.myphotoid.AdditionalPhoto",
                    "id": 76,
                    "links": {
                        "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/additional-photo-kshctuu4cio5si57oarqsih2ghn6t970vtpsmbcqlpq21aljl9lce301qcqdqtas.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
                    }
                },
                {
                    "additionalPhotoType": {
                        "deleteOnDownload": null,
                        "enableCardholderCropping": null,
                        "errors": {
                            "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"externalURL": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52.jpg",
                        "email": "tony+wje@sharptop.co""lastUpdated": "2022-09-01T16:43:07Z",
        "helperBotReviewed": true,
        "classifications": [
    "password": "$2a$10$/nZFbCh84V1hhQijf9PtkeY7q5LXlfhSB/NCL9jT7XRIXnJrT2D4a",        {
                "identifierid": "647",
      645260,
                 "activatedDatescore": null0.6342,
                "photoRequirement": {
      "unsubscribe": false,                 "id": 125
       "enabled": true,        },
                "accountExpiredrequirementName": false,"HelperBot"
            }
        ],
  "accountLocked": false,     "aspectRatio": 0.7481296758104738,
        "height": 401,
        "passwordExpiredbackgroundReplaced": falsetrue,
        "downVotes": 0,
        "automaticallyApprovedOrDenied": false,
        "passwordResetRequiredpublicKey": false"000008.22.244.n4k3o3kfitp01n1cjje3ug2q7rs3tdi7p7r6pl8i9ja99q4q426pqo97guf6bnja1tm9jhcsrlm9ml52",
             "manuallyEdited": true,
          "additionalPhotoRequiredstatus": true"PENDING",
        "domainClass": "us.cloudcard.api.Photo",
              "dateTermsAccepted"version": "2020-10-05T19:25:57Z"1,
        "person": {
              "dateCreated": "2020-09-01T15:29:10Z","id": 577122,
            "username": "test_user2@cloudcard.us",
            "lastUpdatedemail": "2020-10-15T13:19:52Ztest_user2@cloudcard.us",
            "identifier": "123232323",
            "dateArchivedadditionalPhotoRequired": nulltrue,
            "domainClass": "us.cloudcard.api.Person",
            "preArchiveEmailversion": null13,
            "additionalPhotos": [
           "preArchiveUsername": null,    {
                    "preArchiveIdentifierid": null75753,

                       "idadditionalPhotoType": 942,{
                        "versionname": 9"Government issued ID",
                  }      "enableOcr": false,
          }             ], "enableFacialRecognition": false,
          "additionalPhotoRequired": true,             "previouslyApprovedPhotoenableGovIdClassifier": nullfalse,
               },         "personHasApprovedPhotogoodFacialRecognitionThreshold": false0.9,
         "publicKey": "ct1ilj1mkb8iokq2mj95lahnjq80k49b1mhhc861o3k570qr05n2gcvad4nvdl6n",         "status": "PENDING",    "badFacialRecognitionThreshold": 0.5
   "version": 3     },     {      },
  "aspectRatio": 1.0,         "classifications": [       "facialRecognitionScore": null,
    {                "facialRecognitionClassification": "id": 556,unclassified",
                    "scoregovIdScore": 0.963null,
                    "requirementNamegovIdClassification": "Helper Botunclassified",
            }         ]"lowestClassification": "unclassified",
        "domainClass": "com.campuscardtools.myphotoid.Photo",            "helperBotReviewedpublicKey": true"additional-photo-8.2022.228.duesuml0bahqp0losds5onkudij4f3j54e2v15s4coje43irqt1ekm27bkcg6a0a",
        "id": 1697,            "isAspectRatioCorrectlinks": true,{
          "links": {             "bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/jti0njqc66nor0n2reo4vgu6tql6kl2ok2hs1ipehjjv35k0nca987mlht8iebsr.jpg"additional-photo-8.2022.228.duesuml0bahqp0losds5onkudij4f3j54e2v15s4coje43irqt1ekm27bkcg6a0a.jpg"
                    }
                }
            ],
   },         "lowestClassificationpreviouslyApprovedPhoto": 0.963null,
            "originalPhotocustomFields": {
                "idmessage": 1696, "deliberately not rendered"
            }
        },
        "publicKeylowestClassification": "ki8g3gbrc9sdt6sqnmc1roob37hiru0ans95su1suue5usvbgm42aen0kqigc0jc",
0.6342,
        "isAspectRatioCorrect": true,
           "links": {
   
            "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
    }
]