Skip to content

Return Profile Notes By Note Id

Request

Returns a profile note based on profile id and note id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
noteIdstringrequired

Id of a note.

Example:047ae398-7639-40af-911e-cc214cf3045c
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes/047ae398-7639-40af-911e-cc214cf3045c \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstring

Id of the note.

bodystring or null

Body of the note.

isArchivedboolean

Value indicating whether the note is archived.

createdAtstring

Note created time.

createdByIdnumber

Id of the user who created note.

createdBystring

Name of the user who created note.

modifiedAtstring

Note last updated time.

modifiedByIdnumber

Id of the user who last modified the note.

modifiedBystring or null

Name of the user who last modified the note.

linkedTostring or null

The profile component to which current not is linked to.

correlationIdstring

A unique ID assigned to this request.

Response
{ "id": "string", "body": "string", "isArchived": true, "createdAt": "string", "createdById": 0, "createdBy": "string", "modifiedAt": "string", "modifiedById": 0, "modifiedBy": "string", "linkedTo": "string", "correlationId": "string" }