Page Comparison

Info
This Example Project demonstrates how to consume this API endpoint within a C# project.
URI: https://api.onlinephotosubmission.com/
...
person/{id
...
}
...
Example URI: https://api.onlinephotosubmission.com/
...
person/123
Example URI: https://api.onlinephotosubmission.com/
...
person/jon.doe@foo.edu?findBy=email
...
Example URI: https://api.onlinephotosubmission.com/
...
person/A1234567?findBy=identifier
Optional URL Parameters: findBy=[id|email|identifier] (default id)
...
. Note, findBy must be used when querying email/identifier
Note
DEPRECATION NOTICE: The URI https://api.onlinephotosubmission.com/api/people/{ id \| email \| identifier} is now deprecated and will no longer be supported on or after April October 1, 20192022.
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
...
Code Block
title	Example Response
200 OK

{
    "accountExpired": false,
    "accountLocked": false,
    "activatedDate": null,
    "additionalPhotoRequired": false,
    "additionalPhotos": {200 OK

{
    "id": 577782,
    "dateCreated": "2022-01-31T18:16:40Z",
    "passwordResetRequired": false,
    "organization": {
        "id": 100133,
        "isPaid": true,
        "downloadLabel": "Download Photos",
        "allowAutoCrop": false,
        "logoutUrl": "",
        "allowAutoRotate": false,
        "allowAutoDenial": false,
        "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
        },
        "name": "Postman Test",
        "badPhotoThreshold": 0.4,
        "helpScoutBeacons": [],
        "allowAutoBackgroundReplacement": false,
        "sendEmailFrom": "Online Photo Submission <sent.from.customer@onlinephotosubmission.com>",
        "identifier": null,
        "emailReplyTo": null,
        "approvalsPerDay": 10,
        "expirationDate": null,
        "backgroundColor": null,
        "parent": null,
        "allowAutoApproval": false,
        "termsOfService": null,
        "siteURL": "",
        "autoArchiveAction": null,
        "daysBetweenInvitations": 14,
        "lastUpdated": "2022-01-31T18:17:29Z",
        "backgroundImage": null,
        "sendAutomaticFeedback": false,
        "usePersonIdentifier": true,
        "emailDomains": [],
        "autoArchiveStatus": null,
        "additionalPhotoTypes": [],
        "defaultGroup": {
            "id": 108,
            "organization": {
                "id": 100133
            },
            "receivableEmails": ",empty",
            "name": "Default",
            "domainClass": "us.cloudcard.api.EmailGroup",
            "version": 0
        },
        "goodPhotoThreshold": 0.8,
        "personIdentifierLabel": "ID Number",
        "preventMultiplePhotos": false,
        "customCssUrl": "",
        "useEmailAsUsername": true,
        "helperBotDelay": 600000,
        "downloadStrategy": {
            "id": "ZIP",
            "name": "Zip File"
        },
        "approvalsMadeToday": 0,
        "backgroundReplacementEnabled": false,
        "canApproveMorePhotosToday": true,
        "customFields": [],
        "photoRequirements": [
            {
                "id": 100851,
                "listIndex": 0,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Crop",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Should be cropped slightly above head to middle of chest",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100852,
                "listIndex": 1,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                 "Government  Issued ID"id": 100133
null     },     "authorities": [     },
   {             "authorityuniqueName": "ROLE_CARDHOLDERPlain Background",
                "defaultMappedFieldsclassifierUrl": [null,
                "authorityhidden": false,
                "requirement"id: ",Should be taken against a plain, light background",
         "version"       "version": 0,
    ],             "errors": {"domainClass": "us.cloudcard.api.PhotoRequirement"
            },
    "errors": []         {
   },             "excludedFieldsid": [100853,
                "grailsApplicationlistIndex": 2,
                "springSecurityService"lastUpdated": "2019-04-26T20:30:09Z",
                "messageSourceorganization":     {
       ],             "id": 3,
      100133
      "version": 0         },
     ],     "canSwitchOrganizations": false,     "canViewOrganizationListuniqueName": "Color falsePhoto",
      "currentPhoto": {         "aspectRatioclassifierUrl": 1.0null,
        "classifications": [       "hidden": false,
    {            "requirement": "Must be a color photo"id": 257974,
                "scoreversion": 0.9263,
                "requirementNamedomainClass": "HelperBotus.cloudcard.api.PhotoRequirement"
            },
            {
       ],         "domainClassid": "com.campuscardtools.myphotoid.Photo",100854,
                "helperBotReviewed": true,listIndex": 3,
                "idlastUpdated": 552814,
 "2019-04-26T20:30:09Z",
      "isAspectRatioCorrect": true,         "linksorganization": {
            "bytes": "https://s3.amazonaws.com/....jpg"       "id": 100133
},         "lowestClassification": 0.9263,       },
  "originalPhoto": {             "iduniqueName": "No 552812,Accessories",
                "publicKeyclassifierUrl": "..."null,
                "linkshidden": {false,
                "bytesrequirement": "https://s3.amazonaws.com/....jpg"Must not include sunglasses or hat",
                }
"version": 0,
       },         "persondomainClass": {"us.cloudcard.api.PhotoRequirement"
            "id": 235068,},
            {
  "username": "cia5348@sharptop.io",             "emailid": "cia5348@sharptop.io",100855,
                "identifierlistIndex": "cia5348",4,
                "organizationlastUpdated": {"2019-04-26T20:30:09Z",
                "idorganization": 92, {
                    "nameid": "Test Org.",100133
                "photoRequirements": [...]},
                "identifieruniqueName": "Face nullCamera",
                "badPhotoThresholdclassifierUrl": 0.4null,
                "goodPhotoThresholdhidden": false,
0.8             },   "requirement": "Must be positioned directly facing the camera",
  "additionalPhotos": [],             "additionalPhotoRequiredversion": false
        }0,
        "personHasApprovedPhoto": true,
        "publicKeydomainClass": "us.cloudcard.api.PhotoRequirement",
           "status": "READY_FOR_DOWNLOAD" },
        "version": 171   {
 },     "customFields": {         "Notesid": 100856,
   {             "idlistIndex": 5868565,
                "valuelastUpdated": "Brad Pitt"
 2019-04-26T20:30:09Z",
      }     },     "dateTermsAcceptedorganization": {
   null,     "domainClass": "com.campuscardtools.myphotoid.Person",     "email": "cia5348@sharptop.io",     "emailGroupid": 100133
    {         "id": 23,  },
      "name": "Default",         "receivableEmailsuniqueName": "Look At Camera"login,approval,denial,BAD,GOOD,MAYBE,welcome",
           },     "enabledclassifierUrl": truenull,
      "homeOrganization": {         "idhidden": 92false,
         "hasDescendents": false,      "requirement": "Eyes should "descendents": []
    }be open and looking at the camera",
    "id": 235068,     "identifier": "cia5348",     "linksversion": null0,
      "organization": {         "iddomainClass": 92, "us.cloudcard.api.PhotoRequirement"
           "domainClass": "com.campuscardtools.myphotoid.Organization" },
        "name": "Test Org.",  {
      "isPaid": true,         "termsOfServiceid": "null"100857,
        "photoRequirements": [...],
        "customFieldslistIndex": 6,
   [             {"lastUpdated": "2019-04-26T20:30:09Z",
                "nameorganization": "Notes", {
                    "promptid": null,100133
                "sortOrder": 1},
                "showInListuniqueName": true"Generic",
                "allowUserInputclassifierUrl": false"https://helper-bot.onlinephotosubmission.com/generic",
                "requireUserInputhidden": falsetrue,
                "lastUpdatedrequirement": "2018-12-18T21:05:18Z "Must be a good photo",
                "idversion": 1000670,
                "versiondomainClass": 0"us.cloudcard.api.PhotoRequirement"
            }
        ],
        "customCssUrl": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
   },
    "logoutUrlpreArchiveEmail": null,
    "accountExpired": false,
    "useEmailAsUsernamedateArchived": truenull,
    "unsubscribe": false,
    "usePersonIdentifieridentifier": true"12345600",
 
      "personIdentifierLabelemailGroup": "ID Number",{
        "downloadStrategyid": {108,
            "idorganization": "EXTERNAL",{
            "name": "External Application"id": 100133
        },
        "downloadLabelreceivableEmails": "Download Photos,empty",
        "photoDimensionsname": {
   "Default",
        "widthdomainClass": 200,
   "us.cloudcard.api.EmailGroup",
        "heightversion": 200,0
     },
      "descriptionpreArchiveIdentifier": "200:200 (1:1)"null,
       "dateTermsAccepted": null,
    "idpasswordExpired": 3false,
       "lastUpdated": "2022-01-31T18:16:49Z",
    "versionadditionalPhotoRequired": 0true,
    "quicksightArn": null,
  },    "preArchiveUsername": null,
    "preventMultiplePhotosusername": false,
   "api_example@cloudcard.us",
    "approvalsPerDayaccountLocked": 0false,
   
    "approvalsMadeTodayactivatedDate": 0null,
   
    "canApproveMorePhotosTodayenabled": true,
   
    "emailReplyToemail": "Hello From CloudCard <hello@cloudcardtools.com>",
   api_example@cloudcard.us",
    "helperBotDelaydomainClass": 1000"us.cloudcard.api.Person",
    "authorities": [
   "additionalPhotoTypes":  [   {
         {   "id": 3,
            "errorsauthority": {"ROLE_CARDHOLDER",
            "domainClass": "us.cloudcard.api.Role",
            "errorsversion": []0
        }
    ],
  },  "canViewOrganizationList": false,
        "canSwitchOrganizations": false,
    "namecustomFields": "Government Issued ID"{},
       "homeOrganization": {
        "notBoundid": false100133,
        "hasDescendents": false,
        "promptdescendents": "Do IT!",[]
    },
       "links": null,
    "requiredemail": false
 "api_example@cloudcard.us",
    "identifier": "12345600",
    }
"username": "api_example@cloudcard.us",
    "readOnly": false,
 ]     }"restorable": false,
    "passwordExpiredstatus": false"ACTIVE",
    "passwordResetRequiredadditionalPhotos": false{},
    "readOnlycurrentPhoto": falsenull,
    "unsubscribehelpScoutBeacon": falsenull,
    "usernamepreviouslyApprovedPhoto": "cia5348@sharptop.io"null
}
Versions Compared

Old Version 19

New Version 20

Key
