Add Profiles To Monitoring

Request

Adds a list of profile/s to monitoring.

Each profile is added or listed in failed with the reason. A profile can only be monitored if it has a safeNumber or companyId, such as a profile made with Create Profile From Company Report. Reasons seen: Profile Not Found, Profile Does Not Have SafeNumber or CompanyId, and Profile Is Locked (the profile is still being set up, for example for about a minute after an import).

Security

bearerToken

Headers

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

Bodyapplication/json

The profiles to add to KYC monitoring.

itemsArray of strings, (uuid)required

Provide the list of profile Id's in the array.

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/kycMonitoring/profiles/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97' \
  -d '{
    "items": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Success

Bodyapplication/json

failedArray of objects or null

The profiles that couldn't be added to monitoring, each with the reason.

successfulArray of strings or null

The profile ids that were added to monitoring.

correlationIdstring

A unique ID assigned to this request.

Response

{
  "failed": [
    { … }
  ],
  "successful": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "correlationId": "string"
}