API Reference‎ > ‎People Service‎ > ‎

Resource: `request`

A shared profile made by a person.

Schema

{
  "_type": "share",
  "token": {string},
  "toName": {string},
  "toEmail": {string},
  "message": {string},
  "user": {string},
  "sharedInfo": {
    "sexualOffenderCheckSummary": {boolean},
    "criminalCheckSummary": {boolean},
    "sexualOffenderCheck": {boolean},
    "criminalCheck": {boolean},
    "idVerification": {boolean},
    "website": {boolean},
    "email": {boolean},
    "linkedinProfile": {boolean},
    "googleProfile": {boolean},
    "twitterProfile": {boolean},
    "facebookProfile": {boolean},
    "profilePhoto": {boolean}
  },
  "active": {boolean},
  "views": {number},
  "maxViews": {number},
  "lifetime": {number},
  "creationDate": {date},
  "hasExpired": {boolean},
  "expirationDate": {date},
  "id": {string},
  "_links": {object},
  "_actions": {object}
}

Links

Rel Description
self Link to the current resource.
home Link back to the root of the people api.
person Link to the associated person.

Actions

Global Request Parameters

These request parameters apply to all actions on this resource.

Parameter Type Location Required Description
username string path yes Username of the associated person.
token string path yes Unique token associated with the share.

Action: get

Fetches a shared profile.

Response

If successful, a share resource will be returned in the response body.


Action: put

Updates a shared profile.

Request

A share resource is expected in the request body.

Response

If successful, a share resource will be returned in the response body.


Action: delete

Deletes a shared profile.

Response
TODO: Add response

Action: resend

Resends an email to the shared profile recipient.

Response
TODO: Add response

Action: view

Returns information that is being shared with the recipient.

Response
TODO: Add response

Action: viewAsRecipient

Preview the information that will be seen by the recipient.

Response
TODO: Add response

Comments