URI: https://api.onlinephotosubmission.com/photo[?][status=PENDING][&][offset=0][&][max=25]
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 October 1, 2022.
HTTP Method: GET
Optional Request Parameters:
statusRetrieves only photo in the designated status
Allowable Values:
PENDINGAPPROVEDDENIEDREADY_FOR_DOWNLOADDOWNLOADEDDONEENROUTE
offsetAllows pagination. Skips the number of photos designated.
Default Value:
0Allowable Values: any integer greater than or equal to
0
maxAllows pagination. Limits the number of photos retrieved.
Default Value:
25Allowable Values: any integer between
0and1000
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.
Example HTTP Request Body
{EMPTY}
Example Response
200 OK
[
{
"aspectRatio": 1.0,
"classifications": [
{
"id": 557,
"score": 0.8875,
"requirementName": "Helper Bot"
}
],
"domainClass": "com.campuscardtools.myphotoid.Photo",
"helperBotReviewed": true,
"id": 1699,
"isAspectRatioCorrect": true,
"links": {
"bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/ct1ilj1mkb8iokq2mj95lahnjq80k49b1mhhc861o3k570qr05n2gcvad4nvdl6n.jpg"
},
"lowestClassification": 0.8875,
"originalPhoto": {
"id": 1698,
"publicKey": "vjnnaolk42p47bc29l1mdhsjq7p6cb1m38inm5b09p6rt1rq33p2jiasph77e6u9",
"links": {
"bytes": "https://s3.amazonaws.com/test-photos.onlinephotosubmission.com/vjnnaolk42p47bc29l1mdhsjq7p6cb1m38inm5b09p6rt1rq33p2jiasph77e6u9.jpg"
}
},
"person": {
"id": 942,
"username": "john@company.com",
"email": "john@company.com",
"identifier": "647",
"organization": {...},
"additionalPhotos": [
{
"additionalPhotoType": {
"deleteOnDownload": null,
"enableCardholderCropping": null,
"errors": {
"errors": []
},
"name": "Signature",
"notBound": false,
"photoDimensions": {
"defaultMappedFields": [
"width",
"height",
"description",
"id",
"version"
],
"description": "180 60 (3:1)",
"errors": {
"errors": []
},
"excludedFields": [
"grailsApplication",
"springSecurityService",
"messageSource"
],
"height": 60,
"id": null,
"longSide": 180,
"shortSide": 60,
"value": 3.0,
"version": null,
"width": 180
},
"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",
"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://s3.amazonaws.com/test-photos.onlinephotosubmission.com/ki8g3gbrc9sdt6sqnmc1roob37hiru0ans95su1suue5usvbgm42aen0kqigc0jc.jpg"
}
},
"person": {
"id": 1,
"username": "a",
"email": "a@foo.edu",
"identifier": "1",
"organization": {...},
"additionalPhotos": [],
"additionalPhotoRequired": false,
"previouslyApprovedPhoto": null
},
"personHasApprovedPhoto": false,
"publicKey": "jti0njqc66nor0n2reo4vgu6tql6kl2ok2hs1ipehjjv35k0nca987mlht8iebsr",
"status": "PENDING",
"version": 2
}
]