Skip to content
Connect API Catalog/
/
/
Assigns A List Of Profile...

Assigns A List Of Profiles To User

Request

Assigns list of profiles to a user.

Security
bearerToken
Bodyapplication/json
userIdinteger, (int32)

Id of the User to assign the Profiles. Passing null will unassign the profile

profileIdsArray of strings, (uuid)required

List of profiles to assign a user

curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/assign/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": 0,
    "profileIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Success

Bodyapplication/json
Array [
idstring, (uuid)

Id of the Profile

namestring

Name of the Profile

riskRatingstring

Risk rating given to profile. Available values are notApplicable, veryLow, low, medium, high and veryHigh.

statusstring

Status of the profile. Available values are new, approved, declined, pending, cancelled, referred, closed and approvedReviewDue.

typestring

Type of the profile. Available values are trust, individual, soleTrader, company, plc, partnership and otherEntity.

internalIdobject

Internal Id given to profile by customer

assignedToIdobject, (int32)

Id of the user assigned to the profile

assignedToobject

Name of the user assigned to the profile

safeNumberobject

safe number of the business linked to the profile

companyIdobject

company id of the business linked to the profile

formationDateobject, (date)

Formation date of the business linked to the profile

createdAtstring, (date-time)

Profile created time

createdByIdinteger, (int32)

Id of the user who created the profile

createdBystring

Name of the user who created the profile

modifiedAtobject, (date-time)

Profile last updated time

modifiedByIdobject, (int32)

Id of the user who last modified the profile

modifiedByobject

Name of the user who last modified the profile

kycApprovedAtstring, (date-time)

Date when the profile got approved

kycReviewOnobject, (date)

Date when profile is to be reviewed

kycStatusUpdatedOnobject, (date-time)

Date when the profile status was last updated

kycCommentsobject

Profile comments

noteCountinteger, (int32)

Count of notes associated with profile

attachmentCountinteger, (int32)

Count of attachments associated with profile

keyPartyCountinteger, (int32)

Count of key parties associated with profile

uboCountinteger, (int32)

Count of UBOs associated with profile

openAlertCountinteger, (int32)

Count of Open Alerts

modeOfCreationstring

Mode of profile creation. Available values are manual, import and batchUpload.

importStatusobject

Status of profile creation. Available values are submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted and failed.

isLockedboolean

Value indicating whether the profile is locked

isKycMonitoredboolean

Value indicating whether the profile is kyc monitored

correlationIdstring
]
Response
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "riskRating": "string",
    "status": "string",
    "type": "string",
    "internalId": {},
    "assignedToId": {},
    "assignedTo": {},
    "safeNumber": {},
    "companyId": {},
    "formationDate": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "createdById": 0,
    "createdBy": "string",
    "modifiedAt": {},
    "modifiedById": {},
    "modifiedBy": {},
    "kycApprovedAt": "2019-08-24T14:15:22Z",
    "kycReviewOn": {},
    "kycStatusUpdatedOn": {},
    "kycComments": {},
    "noteCount": 0,
    "attachmentCount": 0,
    "keyPartyCount": 0,
    "uboCount": 0,
    "openAlertCount": 0,
    "modeOfCreation": "string",
    "importStatus": {},
    "isLocked": true,
    "isKycMonitored": true,
    "correlationId": "string"
  }
]