...
...
...
...
| Info |
|---|
This This Example Project demonstrates demonstrates how to consume this API endpoint within a C# project. |
URI: https://api.
...
cloudcard.
...
us/
...
person/
...
{id
...
}
...
Example URI: https://api.
...
cloudcard.
...
us/
...
person/
...
123
...
Example URI:
...
https://api.
...
cloudcard.
...
us/
...
person/
...
jon.doe@foo.edu?findBy=email
...
Example URI: https://api.
...
cloudcard.
...
us/
...
person/
...
A1234567?findBy=identifier
...
Optional URL Parameters: findBy=[id|email|identifier] (default id)
...
. Note, findBy must be used when querying email/identifier
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
...
...
Example HTTP Request Body
| Code Block |
|---|
(LEAVE REQUEST BODY EMPTY) |
| Code Block |
Example Response
| Code Block | ||
|---|---|---|
| ||
200 OK { "accountExpiredid": false577782, "accountLocked": false, "activatedDate"dateCreated": "20152022-0401-11T1731T18:2616:28Z40Z", "additionalPhotoRequiredpasswordResetRequired": truefalse, "additionalPhotosorganization": { "Government Issued IDid": null100133, }, "authoritiesisPaid": [true, { "downloadLabel": "Download Photos", "classallowAutoCrop": "com.campuscardtools.myphotoid.Role"false, "idlogoutUrl": 4"", "authorityallowAutoRotate": "ROLE_DIRECTOR"false, }"allowAutoDenial": false, { "allowDeprecatedEndpoints": false, "classmaxNumberOfInvitations": "com.campuscardtools.myphotoid.Role", 0, "idphotoDimensions": 2,{ "authorityid": "ROLE_OFFICE" 6, }, {"width": 300, "classheight": "com.campuscardtools.myphotoid.Role"300, "description"id: "300: 3300 (1:1)", "authoritydomainClass": "ROLE_CARDHOLDER"us.cloudcard.api.PhotoDimensions", } "version": ]0, "currentPhoto": { "aspectRatiovalue": 1.0.75, "classificationslongSide": 300, [ {"shortSide": 300 }, "idname": 145302"Postman Test", "score"badPhotoThreshold": 0.99634, "helpScoutBeacons": [], "requirementNameallowAutoBackgroundReplacement": "Helperfalse, Bot" "sendEmailFrom": "Online Photo Submission }<sent.from.customer@onlinephotosubmission.com>", "identifier": ]null, "domainClassemailReplyTo": "com.campuscardtools.myphotoid.Photo"null, "helperBotReviewedapprovalsPerDay": true10, "idexpirationDate": 244004null, "isAspectRatioCorrectbackgroundColor": falsenull, "linksparent": null, { "allowAutoApproval": false, "bytestermsOfService": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1.jpg"null, }"siteURL": "", "lowestClassificationautoArchiveAction": 0.9963null, "originalPhotodaysBetweenInvitations": {14, "idlastUpdated": 243992"2022-01-31T18:17:29Z", "publicKeybackgroundImage": "u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo"null, "sendAutomaticFeedback": false, "links": { "usePersonIdentifier": true, "bytesemailDomains": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo.jpg"[], "autoArchiveStatus": null, } }"additionalPhotoTypes": [], "persondefaultGroup": { "id": 90108, "usernameorganization": "director@sharptop.co", { "emailid": "director@sharptop.co",100133 "identifier": "d256436"}, "organizationreceivableEmails": { ",empty", "idname": 92"Default", "namedomainClass": "Test Org.us.cloudcard.api.EmailGroup", "photoRequirementsversion": [...],0 }, "identifiergoodPhotoThreshold": null0.8, "personIdentifierLabel": "ID Number", "badPhotoThresholdpreventMultiplePhotos": 0.4false, "customCssUrl": "", "goodPhotoThresholduseEmailAsUsername": 0.8true, }, "helperBotDelay": 600000, "additionalPhotosdownloadStrategy": [],{ "additionalPhotoRequiredid": true"ZIP", "previouslyApprovedPhotoname": {"Zip File" }, "aspectRatioapprovalsMadeToday": 0, "backgroundReplacementEnabled": false, "classificationscanApproveMorePhotosToday": []true, "customFields": [], "domainClassphotoRequirements": "com.campuscardtools.myphotoid.Photo",[ "helperBotReviewed": false,{ "id": 136100851, "isAspectRatioCorrectlistIndex": false0, "linkslastUpdated": {"2019-04-26T20:30:09Z", "organization": { "bytes": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936.jpg" }, "id": 100133 "lowestClassification": null}, "originalPhotouniqueName": null"Crop", "personclassifierUrl": {null, "idhidden": 90false, "usernamerequirement": "director@sharptop.co", Should be cropped slightly above head to middle of chest", "emailversion": "director@sharptop.co"0, "identifierdomainClass": "d256436",us.cloudcard.api.PhotoRequirement" }, "organization": { { "id": 92100852, "listIndex": 1, "name": "Test Org.", "lastUpdated": "2019-04-26T20:30:09Z", "photoRequirementsorganization": [...],{ "identifierid": null,100133 }, "badPhotoThreshold": 0.4, "uniqueName": "Plain Background", "goodPhotoThresholdclassifierUrl": 0.8null, "hidden": false, }, "requirement": "Should be taken against a plain, light "additionalPhotos": [],background", "version": 0, "additionalPhotoRequired": true "domainClass": "us.cloudcard.api.PhotoRequirement" }, }, "personHasApprovedPhoto": true, { "publicKeyid": "419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936"100853, "statuslistIndex": "DONE"2, } "lastUpdated": "2019-04-26T20:30:09Z", }, "personHasApprovedPhotoorganization": true,{ "publicKey": "9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1", "statusid": "PENDING"100133 }, "customFields": { }, "First Name": null, "Last Name": null }, "dateTermsAccepteduniqueName": "2015-05-24T06:44:54ZColor Photo", "domainClass": "com.campuscardtools.myphotoid.Person", "email": "director@sharptop.co", "emailsReceivedclassifierUrl": [null, { "addresshidden": "director@sharptop.co"false, "formattedTimestamp "requirement": "10-19-2017 11:23 AM EDTMust be a color photo", "subjectversion": "Your0, Photo Was Approved", "timestampdomainClass": "2017-10-19 11:23:17.0us.cloudcard.api.PhotoRequirement" }, { "addressid": "director@sharptop.co",100854, "formattedTimestamplistIndex": "10-20-2017 02:29 PM EDT",3, "subjectlastUpdated": "Instant Photo Feedback2019-04-26T20:30:09Z", "timestamp": "2017-10-20 14:29:29.0" "organization": { }, { "id": 100133 "address": "director@sharptop.co", "formattedTimestamp": "Jan 19 12:47 PM EST",}, "subjectuniqueName": "Your Photo Was Approved",No Accessories", "timestampclassifierUrl": "2018-01-19 12:47:53.0" null, }, {"hidden": false, "addressrequirement": "director@sharptop.coMust not include sunglasses or hat", "formattedTimestampversion": "Jun0, 20 12:34 AM EDT", "subjectdomainClass": "Instant Photo Feedback",us.cloudcard.api.PhotoRequirement" }, "timestamp": "2018-06-20 00:34:42.0" },{ { "id": 100855, "address": "director@sharptop.co", "formattedTimestamplistIndex": "Sep4, 26 10:07 AM EDT", "subjectlastUpdated": "Instant Photo Feedback",2019-04-26T20:30:09Z", "timestamporganization": "2018-09-26 10:07:24.0" { } ], "enabledid": 100133 true, "homeOrganization": { "id": 8}, "hasDescendents": true, "descendentsuniqueName": ["Face Camera", { "classifierUrl": null, "id": 92 "hidden": false, }, { "id": 100064 "requirement": "Must be positioned directly facing the camera", }, "version": 0, { "iddomainClass": 46"us.cloudcard.api.PhotoRequirement" }, { "id": 100079100856, }, "listIndex": 5, { "lastUpdated": "2019-04-26T20:30:09Z", "id": 100047 "organization": { }, { "id": 100133 "id": 100096 }, }, "uniqueName": "Look At {Camera", "idclassifierUrl": 87null, }, "hidden": false, { "id": 91"requirement": "Eyes should be open and looking at the camera", } "version": 0, ] }, "iddomainClass": 90,"us.cloudcard.api.PhotoRequirement" "identifier": "d256436", "links": null}, "organization": { { "id": 92, "domainClass "id": "com.campuscardtools.myphotoid.Organization", 100857, "name": "Test Org.", "isPaidlistIndex": true6, "termsOfService": null, "photoRequirementslastUpdated": [...]"2019-04-26T20:30:09Z", "customFields": [ "organization": { { "nameid": "First Name"100133 }, { "uniqueName": "Generic", "nameclassifierUrl": "Last Name"https://helper-bot.onlinephotosubmission.com/generic", } "hidden": true, ], "customCssUrlrequirement": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css", Must be a good photo", "useEmailAsUsername": true, "usePersonIdentifierversion": true0, "personIdentifierLabel": "ID Number", "domainClass": "us.cloudcard.api.PhotoRequirement" "downloadStrategy": { } "id": "EXTERNAL", ] }, "namepreArchiveEmail": "External Application" null, "accountExpired": false, "dateArchived": null, }, "unsubscribe": false, "downloadLabelidentifier": "Download Photos12345600", "emailGroup": { "photoDimensions": { "id": 108, "classorganization": "com.campuscardtools.myphotoid.PhotoDimensions",{ "id": 100133 3, }, "descriptionreceivableEmails": "200:200,empty", "heightname": 200"Default", "width": 200"domainClass": "us.cloudcard.api.EmailGroup", },"version": 0 }, "preventMultiplePhotospreArchiveIdentifier": falsenull, "approvalsPerDaydateTermsAccepted": 0null, "approvalsMadeTodaypasswordExpired": 0false, "lastUpdated": "2022-01-31T18:16:49Z", "canApproveMorePhotosTodayadditionalPhotoRequired": true, "quicksightArn": null, "emailReplyTopreArchiveUsername": "Hello From CloudCard <hello@cloudcardtools.com>null, "username": "api_example@cloudcard.us", "accountLocked": false, "helperBotDelayactivatedDate": 1000 null, "enabled": true, "email": "api_example@cloudcard.us", "domainClass": "us.cloudcard.api.Person", "authorities": [ { "id": 3, "authority": "ROLE_CARDHOLDER", "domainClass": "us.cloudcard.api.Role", "version": 0 } ], "canViewOrganizationList": false, "canSwitchOrganizations": false, "customFields": {}, "homeOrganization": { "id": 100133, "hasDescendents": false, "descendents": [] }, "links": null, "email": "api_example@cloudcard.us", "identifier": "12345600", "username": "api_example@cloudcard.us", "readOnly": false, "restorable": false, "status": "ACTIVE", "additionalPhotos": {}, "currentPhoto": { "id": 3678, "dateCreated": "2023-06-26T15:01:12Z", "upVotes": 0, "width": 600, "dateApproved": null, "externalURL": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg", "lastUpdated": "2023-06-26T15:01:12Z", "helperBotReviewed": false, "aspectRatio": 1.0, "height": 600, "backgroundReplaced": false, "additionalPhotoTypesdownVotes": [0, "automaticallyApprovedOrDenied": false, { "publicKey": "000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQ52va5u4lB58RBFc7OoRTUQSr9Jr21HU30hhfSe4nVjPQM4ji", "errorsmanuallyEdited": {false, "status": "PENDING", "errorsdomainClass": []"us.cloudcard.api.Photo", "person": {...removed for brevity...}, "classifications": [], "namelowestClassification": "Governmentnull, Issued ID", "isAspectRatioCorrect": true, "notBoundlinks": false,{ "prompt": "Please submit a photo of your government issued ID.", "bytes": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg" }, "requiredoriginalPhoto": falsenull, "personHasApprovedPhoto": false, } "version": 0, ] }, "passwordExpiredonHoldReasons": false,[] "passwordResetRequired": false}, "readOnlyhelpScoutBeacon": falsenull, "usernamepreviouslyApprovedPhoto": "director@sharptop.co"null } |