Create Profile Note

Request

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

Security

bearerToken

Path

profileIdstringrequired

Id of a profile.

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

Bodyapplication/json

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' \
  -d '{
    "body": "The body of the note to be added. Limited to 1000 characters"
  }'

Responses

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

Example:"f447fa87-d538-4ccb-9bac-43084d840a12"

Response

{
  "id": "c3966c5f-576e-4770-902b-eaab894b83d7",
  "body": "testing",
  "isArchived": false,
  "createdAt": "2023-08-08T07:32:06.4989594Z",
  "createdById": 101562008,
  "createdBy": "Amol",
  "modifiedAt": "2023-08-08T07:32:06.4989594Z",
  "modifiedById": 101562008,
  "modifiedBy": "Amol",
  "correlationId": "f447fa87-d538-4ccb-9bac-43084d840a12"
}