Return Created Profiles

Request

Returns a list of profiles ordered by modified date.

Security

bearerToken

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

A search term to filter by. The search term will be matched against names, and internal ids containing the search term.

assigneesinteger, (int32)

The ids of assigned users to filter by.

kycReviewAfterstring, (date)

Filters results based on profiles with a kyc review date after this date.

kycReviewBeforestring, (date)

Filters results based on profiles with a kyc review date after this date.

riskRatingsArray of strings

The risk ratings to filter by. Available values: notApplicable, veryLow, low, medium, high, veryHigh

sortOrderstring

The order in which the items should be sorted. Available values: asc, desc

sortBystring

The field by which the items should be sorted. Available values: modifiedAt, name

statusesArray of strings

The statuses to filter by. Available values: new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles?page=1&pageSize=0&searchTerm=string&assignees=0&kycReviewAfter=2019-08-24&kycReviewBefore=2019-08-24&riskRatings=string&sortOrder=string&sortBy=string&statuses=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

itemsArray of objects

totalSizenumber

correlationIdstring

A unique ID assigned to this request.

Response

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