Return Profile Notes

Request

Returns a list of profile notes for the given profile id.

Security

bearerToken

Path

profileIdstring, (uuid)required

Id of a profile.

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

Query

pageinteger

Starting page number.

Default:1

Example:page=1

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Example:pageSize=10

searchTermstring

Filters the note list by notes with body containing the provided string

isArchivedboolean

Get archived notes based on this flag. Allowed values are true, false or null

Default:false

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?page=1&pageSize=10&searchTerm=string&isArchived=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

Bodyapplication/json

itemsArray of objects

The notes on this page.

totalSizenumber

The total number of notes returned for the given profileId.

correlationIdstring

A unique ID assigned to this request.

Response

{
  "items": [
    { … }
  ],
  "totalSize": 1,
  "correlationId": "02440c28-d43d-4cab-9061-0bfab23a5683"
}