Return Schedule By ProfileId And ScheduleId

Request

Returns a schedule by profileId and scheduleId.

Security

bearerToken

Path

profileIdstring, (uuid)required

id of the profile

scheduleIdstringrequired

id of the schedule

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstring, (uuid)

The id of the schedule

searchIdstring, (uuid)

The id of the search that was being scheduled

isEmailRequiredboolean

Indicates whether the schedule requires an email to be sent when the search is run

emailRecipientsArray of strings

The email recipients that the email should be sent to when the search is run

createdByIdinteger, (int32)

The id of the user who created the schedule

createdAtstring, (date-time)

The time the schedule was created

createdBystring

The name of the user who created the schedule

modifiedByIdinteger, (int32)

The id of the user who last modified the schedule

modifiedAtstring, (date-time)

The time the schedule was last modified

modifiedBystring

The name of the user who last modified the schedule

typestring

The type of the schedule, i.e. business or individual

nameobject

The name used in the search criteria

firstNameobject

The first name used in the search criteria

middleNameobject

The middle name used in the search criteria

lastNameobject

The last name used in the search criteria

genderobject

The gender used in the search criteria, i.e. male or female

dateOfBirthobject, (date)

The date of birth used in the search criteria

countriesArray of strings

The list of country codes used in the search criteria

thresholdinteger, (int32)

The threshold used in the search criteria

datasetsArray of strings

The datasets used in the search criteria

sanctionBodiesArray of integers or null

Provided sanctionBodies for the search

pepTiersArray of strings

The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3

correlationIdstring

A unique ID assigned to this request.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  "isEmailRequired": true,
  "emailRecipients": [
    "string"
  ],
  "createdById": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedById": 0,
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedBy": "string",
  "type": "string",
  "name": {},
  "firstName": {},
  "middleName": {},
  "lastName": {},
  "gender": {},
  "dateOfBirth": {},
  "countries": [
    "string"
  ],
  "threshold": 0,
  "datasets": [
    "string"
  ],
  "sanctionBodies": [
    0
  ],
  "pepTiers": [
    "string"
  ],
  "correlationId": "string"
}