Skip to main content
POST
/
api
/
handshake
/
profile
requestEntityProfileReport
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/handshake/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "entityGuid": "<string>",
  "sourceShortName": "<string>"
}'
{
  "crps": [
    {
      "active": true,
      "forms": {},
      "id": 123,
      "profileId": 123,
      "profileReferenceId": "<string>",
      "referenceId": "<string>",
      "roles": [
        {
          "appointedDate": "2023-12-25",
          "id": 123,
          "resignedDate": "2023-12-25",
          "role": "<string>"
        }
      ],
      "type": "CORPORATE"
    }
  ],
  "customerDto": {
    "active": true,
    "assigneeId": 123,
    "batchUploadId": 123,
    "forms": {},
    "id": 123,
    "profileId": 123,
    "profileReferenceId": "<string>",
    "referenceId": "<string>",
    "type": "CORPORATE",
    "vendorEntityGuid": "<string>",
    "vendorName": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

HandShakeAuth
string
required

HandShakeAuth

Body

application/json

request

entityGuid
string
required
sourceShortName
string
required

Response

OK

crps
CRPRequestDto · object[]
customerDto
object