Skip to content
Connect API Catalog/Creditsafe Connect/
/Profile Management

Create Profile

Request

Uses the name and type provided by the user to create a profile.

Security
bearerToken
Bodyapplication/json
namestring or nullrequired

The name of the profile being created.
This MUST be unique across your profiles.

typestring or nullrequired

The profile type to be created. This will effect searches later for validations.
i.e. Not being able to apply certain datasets (Example - State Owned Enterprises) to an Individual profile. Ensure the correct type is applied for intended search.

Enum:"trust""individual""soleTrader""company""plc""partnership""otherEntity"
Example:"trust"
internalIdstring or null

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

assignedToIdinteger or null

Creditsafe Id of the user to assign the profile to.

kycReviewOnstring or null

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.

statusstring or null

Status of the profile.

Enum:"new""approved""declined""pending""cancelled""referred""closed""approvedReviewDue"
riskRatingstring or null

Risk rating of the profile.

Enum:"notApplicable""veryLow""low""medium""high""veryHigh"
kycCommentsstring or null

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

detailsobject

Please note the required property in this object.

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "type": "trust",
    "internalId": "string",
    "assignedToId": 0,
    "kycReviewOn": "string",
    "status": "new",
    "riskRating": "notApplicable",
    "kycComments": "string",
    "details": {
      "legalName": "Creditsafe Ltd",
      "tradingName": null,
      "aliases": null,
      "activity": "62409",
      "description": "Example Free Text",
      "contactName": null,
      "email": "example@creditsafe.com",
      "website": "www.creditsafe.com",
      "telephone": null,
      "turnover": {
        "currencyCode": "eur",
        "amount": 0
      },
      "assetsUnderManagement": {
        "currencyCode": "eur",
        "amount": 0
      },
      "organizationNumber": "12345678",
      "internalContact": null,
      "internalEmail": null,
      "dateOfBirth": "2024-03-25",
      "countryCode": "GB",
      "vatNo": "GB12345678",
      "isListedOnExchange": null,
      "exchangeName": null
    }
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)

Id of the Profile

namestring

Name of the Profile

riskRatingstring

Risk rating given to profile (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 or null

Internal Id given to profile by customer

assignedToIdinteger or null

Id of the user assigned to the profile

assignedTostring or null

Name of the user assigned to the profile

safeNumberstring or null

safe number of the business linked to the profile

companyIdstring or null

company id of the business linked to the profile

formationDatestring or null, (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 or null, (int32)

Id of the user who last modified the profile

modifiedBystring or null

Name of the user who last modified the profile

kycApprovedAtstring or null, (date-time)

Date when the profile got approved

kycReviewOnstring or null, (date)

Date when profile is to be reviewed

kycStatusUpdatedOnstring or null, (date-time)

Date when the profile status was last updated

kycCommentsstring or null

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)

isLockedboolean

Indicates whether the profile is locked during data import processes. When false, the profile is unlocked and all import processes have completed. Use this property rather than importStatus to determine if data importing has finished.

detailsobject
importStatusstring or nulldeprecated

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

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "riskRating": "string",
  "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,
  "details": {
    "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
    "legalName": "string",
    "tradingName": "string",
    "aliases": [ … ],
    "activity": "string",
    "description": "string",
    "contactName": "string",
    "email": "string",
    "website": "string",
    "telephone": "string",
    "turnover": { … },
    "assetsUnderManagement": { … },
    "dateOfBirth": "2019-08-24",
    "countryCode": "string",
    "vatNo": "string",
    "isListedOnExchange": true,
    "exchangeName": "string",
    "organizationNumber": "string",
    "internalContact": "string",
    "internalEmail": "string",
    "internationalScore": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdById": 0,
    "createdBy": "string",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "modifiedById": 0,
    "modifiedBy": "string",
    "noteCount": 0,
    "attachmentCount": 0
  }
}