Page Comparison

Note
This endpoint should only be used to create a person. The ability to update a person via this endpoint has been deprecated. If you need to update a person, please refer to the Update a Person endpoint.

Info
This Example Project demonstrates how to consume an older version this API endpoint within a Java project.

Info
This Example Project demonstrates how to consume an older version of this API endpoint within a C# project.

URI: https://api.onlinephotosubmission.com/api/people

HTTP Method: POST

Required Headers: X-Auth-Token (see: Authentication)

Optional URL Parameters:

sendInvitation=[true|false] default is true If sendInvitation is false, cardholders will not receive an email invitation.
If sendInvitation is true (or not specified), an email invitation will be sent to the cardholder.

Code Block

title	Example HTTP Request Body - Email Only

{
  "email": "jon.doe@foo.edu"
}

Code Block

title	Example HTTP Request Body - Setting other optional fields

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "emailGroupName":"Online Students",
  "additionalPhotoRequired":"true",
  "customFields":{ 
    "Last_Name":"Card",
    "First Name":"Carry A",
    "Upload Date":"2017 - 06 - 22 11:17AM",
    "Batch":"1"
  }
}

...

Info
Because this endpoint is currently being improved, we've included the examples of both the current HTTP response and the proposed HTTP response. Please, be aware this could change in the near future; and contact support if you have more questions.

201 created { "accountExpired": false, "accountLocked": false, "activatedDate": null, "additionalPhotoRequired": true, "additionalPhotos": {}, "authorities": [ {

Code Block

title	Example Response (with ?renderResource=true)
collapse	true

Note

This endpoint should only be used to create a person. If you need to update a person, please refer to the Update a Person endpoint.

Info
This Example Project demonstrates how to consume this API endpoint within a Java project.

Info
This Example Project demonstrates how to consume this API endpoint within a C# project.

URI: https://api.cloudcard.us/person

HTTP Method: POST

Required Headers: X-Auth-Token (see: Authentication)

Optional URL Parameters:

sendInvitation=[true|false] default is true
If sendInvitation is false, cardholders will not receive an email invitation.
If sendInvitation is true (or not specified), an email invitation will be sent to the cardholder.

Example HTTP Request Body - Email Only

Code Block

language	json

{
  "email": "jon.doe@foo.edu"
}

Example HTTP Request Body - Setting other optional fields

Code Block

language	json

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "cardholderGroupName":"Online Students",
  "additionalPhotoRequired":true,
  "enabled":true,
  "customFields":{ 
    "Last_Name":"Card",
    "First Name":"Carry A",
    "Upload Date":"2017 - 06 - 22 11:17AM",
    "Batch":"1"
  }
}

Field Descriptions

Include Page

	Person Field Descriptions
	Person Field Descriptions

Example Response (with ?renderResource=true)

Code Block

201 created
{
    "id": 577784,
    "dateCreated": "2022-01-31T18:34:57Z",
    "passwordResetRequired": false,
    "customFieldValues": [],
    "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": {
                    "id": 100133
                },
                "uniqueName": "Plain Background",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Should be taken against a plain, light background",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100853,
                "listIndex": 2,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Color Photo",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Must be a color photo",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100854,
                "listIndex": 3,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "No Accessories",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Must not include sunglasses or hat",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100855,
                "listIndex": 4,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Face Camera",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Must be positioned directly facing the camera",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100856,
                "listIndex": 5,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Look At Camera",
                "authorityclassifierUrl": "ROLE_CARDHOLDER"null,
                "idhidden": 3false,
            "version": 0   "requirement": "Eyes should be open and }looking at the   ]camera",
    "canSwitchOrganizations": false,     "canViewOrganizationList": false,     "currentPhotoversion": null0,
      "customFields": {         "NotesdomainClass": null"us.cloudcard.api.PhotoRequirement"
      },     "dateTermsAccepted": null},
     "domainClass": "com.campuscardtools.myphotoid.Person",       {
"email": "black.beard@pirates.com",     "emailGroup": {         "id": 23100857,
        "name": "Default",
        "receivableEmailslistIndex": "login,approval,denial,BAD,GOOD,MAYBE,welcome"6,
           },     "enabledlastUpdated": true,"2019-04-26T20:30:09Z",
      "homeOrganization": {         "idorganization": {
92,          "hasDescendents": false,         "descendentsid": []100133
      },     "id": 385828,    },
"identifier": "K0001",     "links": {         "loginuniqueName": null "Generic",
           },     "organizationclassifierUrl": {"https://helper-bot.onlinephotosubmission.com/generic",
        "id": 92,
        "domainClasshidden": "com.campuscardtools.myphotoid.Organization",true,
                "namerequirement": "Test Org.Must be a good photo",
        "isPaid": true,         "termsOfServiceversion": "null"0,
        "photoRequirements": [...],         "customFields": ["domainClass": "us.cloudcard.api.PhotoRequirement"
            }
{        ]
    },
    "namepreArchiveEmail": "Notes"null,
    "accountExpired": false,
    "roles": null,
    "promptdateArchived": null,
    "photos": null,
    "unsubscribe": false,
    "sortOrderidentifier": 1,
           null,
    "showInListemailGroup": true,{
        "id": 108,
        "allowUserInputorganization": false,
   {
            "requireUserInputid": 100133
false,        },
        "lastUpdatedreceivableEmails": "2018-12-18T21:05:18Z,empty",
               "name": "idDefault":,
 100067,       "domainClass": "us.cloudcard.api.EmailGroup",
        "version": 0
    },
    "preArchiveIdentifier": null,
 }   "dateTermsAccepted": null,
    "passwordExpired": ]false,
        "customCssUrllastUpdated": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
 2022-01-31T18:34:57Z",
      "logoutUrladditionalPhotos": null,
   
    "useEmailAsUsernameadditionalPhotoRequired": true,

       "usePersonIdentifierquicksightArn": truenull,
        "personIdentifierLabelpreArchiveUsername": "ID Number"null,
        "downloadStrategyusername": {"jonathan+apiexample@cloudcard.us",
       "accountLocked": false,
    "idactivatedDate": "EXTERNAL"null,
       "enabled": true,
    "nameemail": "External Application"jonathan+apiexample@cloudcard.us",
        },
"domainClass": "us.cloudcard.api.Person",
       "downloadLabel": "Download Photos",
"authorities": [
       "photoDimensions": {
            "widthauthority": 200, "ROLE_CARDHOLDER"
        }
    ],
    "heightcanViewOrganizationList": 200false,
      "canSwitchOrganizations": false,
     "descriptioncustomFields": "200:200 (1:1)",
   {},
    "homeOrganization": {
        "id": 3100133,
 
          "versionhasDescendents": false,
 0       "descendents": []
},    },
    "preventMultiplePhotoslinks": false,{
        "approvalsPerDaylogin": 0,"https://test-app.onlinephotosubmission.com/#/login?auth_token=bfki4g6mod5t9ff93sl83jokn06jnmddm6obnpb6vbittg7dfjv1dsscki6v1jjn"
    },
    "approvalsMadeTodayemail": 0,
   "jonathan+apiexample@cloudcard.us",
    "canApproveMorePhotosTodayidentifier": truenull,
 
      "emailReplyTousername": "Hello From CloudCard <hello@cloudcardtools.com>jonathan+apiexample@cloudcard.us",
        "helperBotDelayreadOnly": 1000
    }false,
    "passwordExpiredrestorable": false,
    "passwordResetRequiredstatus": false"ACTIVE",
    "readOnlyadditionalPhotos": false{},
    "unsubscribecurrentPhoto": falsenull,
    "usernamepreviouslyApprovedPhoto": "black.beard@pirates.com"
}

Code Block

title	Example Response

202 ACCEPTED
Headers: 
  Location: https://api.onlinephotosubmission.com/api/people/{id}
null
}

Versions Compared

Old Version 40

New Version Current

Key

Example HTTP Request Body - Setting other optional fields

Field Descriptions

Example Response (with ?renderResource=true)