Creditsafe Connect API Documentation

Create Profile

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

SecuritybearerToken

Request

Request Body schema: application/json

name required	string The name of the profile being created. This MUST be unique across your profiles.
type required	string 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"
internalId	string Internal ID of the profile, this MUST be unique across your profiles.
assignedToId	integer Creditsafe Id of the user to assign the profile to.
kycReviewOn	string 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.
status	string Status of the profile. Enum: "new" "approved" "declined" "pending" "cancelled" "referred" "closed" "approvedReviewDue"
riskRating	string Risk rating of the profile. Enum: "notApplicable" "veryLow" "low" "medium" "high" "veryHigh"
kycComments	string Free text field for users to highlight key information to other users. Maximum characters allowed is 250
	object Please note the required property in this object.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/compliance/kyc-protect/profiles

Request samples

application/json

{"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
}
}

Response samples

application/json

{"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": ["string"
],
"activity": "string",
"description": "string",
"contactName": "string",
"email": "string",
"website": "string",
"telephone": "string",
"turnover": {"currencyCode": "string",
"amount": 0
},
"assetsUnderManagement": {"currencyCode": "string",
"amount": 0
},
"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
}
}

➔ Next to Return Created Profiles