Skip to content
Connect API Catalog/
/
/
Assign Profile To User

Assign Profile To User

Request

Assign a profile to a user

Security
bearerToken
Query
profileIdstringrequired

Id of the profile being assigned to a user

userIdstring

User Id to assign the Profile to

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/assign?profileId=string&userId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstring, (uuid)

Id of the Profile

namestring

Name of the Profile

riskRatingstring

The risk rating being assigned to the profile

Enum:"notApplicable""veryLow""low""medium""high""veryHigh"
statusstring

Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)

typestring

Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)

internalIdstring

Internal Id given to profile by customer

assignedToIdinteger

Id of the user assigned to the profile

assignedTostring

Name of the user assigned to the profile

safeNumberstring

safe number of the business linked to the profile

companyIdstring

company id of the business linked to the profile

formationDatestring, (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

modifiedAtstring or null, (date-time)

Profile last updated time

modifiedByIdinteger, (int32)

Id of the user who last modified the profile

modifiedBystring

Name of the user who last modified the profile

kycApprovedAtstring, (date-time)

Date when the profile got approved

kycReviewOnstring, (date)

Date when profile is to be reviewed

kycStatusUpdatedOnstring, (date-time)

Date when the profile status was last updated

kycCommentsstring

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 (manual, import)

importStatusstring

Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)

isLockedboolean

Value indicating whether the profile is locked

isKycMonitoredboolean

Value indicating whether the profile is under KYC monitoring

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