Skip to content
Connect API Catalog/
/
/
Return Profile By Profile...

Return Profile By Profile Id

Request

Returns a single profile by id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstring, (uuid)

Id of the profile assigned

Example:"fd91185f-c10e-4a42-b0b4-cc367371ebdb"
namestring

The name of the profile

Example:"tej"
riskRatingstring

The risk rating being assigned to the profile

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

The current status of the profile

Enum:"new""approved""declined""pending""cancelled""referred""closed""approvedReviewDue"
Example:"new"
typestring

The type of the profile

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

The internal Id given to the profile by the customer

Example:null
assignedToIdinteger or null

Id of the user assigned to the profile

Example:101562008
assignedTostring or null

Name of the user assigned to the profile

Example:"Amol"
safeNumberstring or null

The safe number linked to the profile

Example:null
companyIdstring or null

The companyID linked to the profile

formationDatestring or null, (date)

Formation date of the business linked to the profile

Example:null
createdAtstring, (date-time)

The profile creating time

Example:"2023-07-25T09:32:40.428637Z"
createdByIdinteger

Id of the user who created the profile

Example:101562008
createdBystring

Name of the user who created the profile

Example:"Amol"
modifiedAtstring or null, (date-time)

The time the profile was last updated

Example:"2023-07-25T14:50:50.170613Z"
modifiedByIdinteger or null

Id of the user who last modified the profile

Example:101562008
modifiedBystring or null

Name of the user who last modified the profile

Example:"Amol"
kycApprovedAtstring or null, (date-time)

The date when the profile got approved at

Example:null
kycReviewOnstring or null, (date)

The date to which the profile is to be reviewed

Example:null
kycStatusUpdatedOnstring or null, (date-time)

Date when the profile status was last updated

Example:"2023-07-25T09:32:40.428637Z"
kycCommentsstring or null

Profile comments

Example:null
noteCountinteger

Count of the number of notes associated to the profile

Example:0
attachmentCountinteger

Count of the number of attachments associated to the profile

Example:0
keyPartyCountinteger

Count of the number of key parties associated to the profile

Example:0
uboCountinteger

Count of the number of UBO's associated to the profile

Example:0
openAlertCountinteger

Count of the number of open alerts associated to the profile

Example:0
modeOfCreationstring

How the record was created [manual, batch]

Example:"import"
importStatusstring or null

The current status of the import

Example:null
isLockedboolean
Example:false
isKycMonitoredboolean
Example:false
correlationIdstring

A unique ID assigned to this request.

Example:"81e542c0-f644-4ef8-ba35-5f16c8681420"
Response
{
  "id": "fd91185f-c10e-4a42-b0b4-cc367371ebdb",
  "name": "tej",
  "riskRating": "notApplicable",
  "status": "new",
  "type": "trust",
  "internalId": null,
  "assignedToId": 101562008,
  "assignedTo": "Amol",
  "safeNumber": null,
  "formationDate": null,
  "createdAt": "2023-07-25T09:32:40.428637Z",
  "createdById": 101562008,
  "createdBy": "Amol",
  "modifiedAt": "2023-07-25T14:50:50.170613Z",
  "modifiedById": 101562008,
  "modifiedBy": "Amol",
  "kycApprovedAt": null,
  "kycReviewOn": null,
  "kycStatusUpdatedOn": "2023-07-25T09:32:40.428637Z",
  "kycComments": null,
  "noteCount": 0,
  "attachmentCount": 0,
  "keyPartyCount": 0,
  "uboCount": 0,
  "openAlertCount": 0,
  "modeOfCreation": "import",
  "importStatus": null,
  "isLocked": false,
  "isKycMonitored": false,
  "correlationId": "81e542c0-f644-4ef8-ba35-5f16c8681420"
}