Return Profile Notes

Request

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

Security

bearerToken

Path

profileIdstringrequired

Id of a profile.

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

Query

pageinteger

Starting page number.

Default:1

pageSizeinteger

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

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

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes?page=1&pageSize=0&searchTerm=string&isArchived=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

itemsArray of objects

totalSizenumber

The total number of notes returned for the given profileId.

correlationIdstring

A unique ID assigned to this request.

Response

{
  "items": [
    { … }
  ],
  "totalSize": 0,
  "correlationId": "string"
}