Update Profile By Profile Id

Updates a single profile by profile Id.

SecuritybearerToken
Request
path Parameters
profileId
required
string

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
Request Body schema: application/json
name
required
string

The name of the profile to be updated.

riskRating
required
string

Risk rating of the profile.

Enum: "notApplicable" "veryLow" "low" "medium" "high" "veryHigh"
status
required
string

Status of the profile.

Enum: "new" "approved" "declined" "pending" "cancelled" "referred" "closed" "approvedReviewDue"
internalId
string

Internal ID of the profile, this MUST be unique across your profiles.

assignedToId
object <int32>

Creditsafe Id of the user to assign the profile to.
Passing null will unassign the profile.

kycReviewOn
object <date>

The date to which the profile should be reviewed.
Format YYYY-MM-DD
Validates when the date changes and is either current or in the future.

kycComments
string

Free text field for users to highlight key information to other users.
Maximum characters allowed is 250

Responses
200
400
401
403
404
409

Conflict

put/compliance/kyc-protect/profiles/{profileId}
Request samples
application/json
{
  • "name": "string",
  • "riskRating": "notApplicable",
  • "status": "new",
  • "internalId": "string",
  • "assignedToId": { },
  • "kycReviewOn": "2021-04-20",
  • "kycComments": "string"
}
Response samples
application/json
{
  • "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
}
➔ Next to Create Profile Note