Skip to content

Return Profile Notes By Note Id

Request

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

Security
bearerToken
Path
profileIdstring, (uuid)required

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
noteIdstring, (uuid)required

Id of a note.

Example:047ae398-7639-40af-911e-cc214cf3045c
Headers
X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97
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>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

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
{ "linkedTo": "profile", "id": "ebafd03a-3bdb-4b15-a858-351ae60fd223", "body": "Contract test note (edited)", "isArchived": true, "createdAt": "2026-11-03T14:40:08.058Z", "createdById": 100000001, "createdBy": "Jane Smith", "modifiedAt": "2026-11-03T14:40:09.006Z", "modifiedById": 100000001, "modifiedBy": "Jane Smith", "correlationId": "469804d2-f004-47f3-ae21-ebaf214c7cb1" }