Skip to content
Connect API Catalog/
/
/
Create Profile Note

Create Profile Note

Request

Adds a note to a profile then Returns the details of the added note.

Security
bearerToken
Path
profileIdstring, (uuid)required

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
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
Bodyapplication/json

The note to add to the profile.

bodystring or null

The body of the note to be added. Limited to 1000 characters

Example:"The body of the note to be added. Limited to 1000 characters"
curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97' \
  -d '{
    "body": "Contract test note"
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)

Id of the note

Example:"c3966c5f-576e-4770-902b-eaab894b83d7"
bodystring or null

Body of the note

Example:"testing"
isArchivedboolean

Value indicating whether the note is archived

Example:false
createdAtstring, (date-time)

Note created time

Example:"2023-08-08T07:32:06.4989594Z"
createdByIdinteger, (int32)

Id of the user who created note

Example:101562008
createdBystring

Name of the user who created note

Example:"Amol"
modifiedAtstring, (date-time)

Note last updated time

Example:"2023-08-08T07:32:06.4989594Z"
modifiedByIdinteger, (int32)

Id of the user who last modified the note

Example:101562008
modifiedBystring or null

Name of the user who last modified the note

Example:"Amol"
correlationIdstring

A unique ID assigned to this request.

Example:"f447fa87-d538-4ccb-9bac-43084d840a12"
Response
{
  "id": "ebafd03a-3bdb-4b15-a858-351ae60fd223",
  "body": "Contract test note",
  "isArchived": false,
  "createdAt": "2026-11-03T14:40:08.058Z",
  "createdById": 100000001,
  "createdBy": "Jane Smith",
  "modifiedAt": "2026-11-03T14:40:08.058Z",
  "modifiedById": 100000001,
  "modifiedBy": "Jane Smith",
  "correlationId": "c8bb5529-d72c-424c-aff4-b7ea0f99c7fa"
}