Skip to content
Connect API Catalog/
/
/
Return Profile Details

Return Profile Details

Request

Fetches details of a profile by profile 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/details \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
profileIdstring, (uuid)

Id of the profile

Example:"2770ac31-8d12-4f69-8f93-326e93cd8c34"
legalNamestring or null

Name of the business/individual

Example:"string"
tradingNamestring or null

Trading name of the entity

Example:"string"
aliasesArray of strings or null

Alias names given for the entity

Example:
[
  "string"
]
activitystring or null

Activity of the business e.g., NAICS/SIC codes

Example:"string"
descriptionstring or null

Description of the entity

Example:"string"
contactNamestring or null

Contact person name

Example:"string"
emailstring or null

Contact email address

Example:"string"
websitestring or null

Entity website address

Example:"string"
telephonestring or null

Contact telephone number

Example:"string"
turnoverobject
Example:
{
  "currencyCode": "eur",
  "amount": 0
}
assetsUnderManagementobject
Example:
{
  "currencyCode": "eur",
  "amount": 0
}
dateOfBirthstring or null, (date)

Date of birth of the individual

Example:"2024-02-27"
countryCodestring or null

Two-letter country code ISO-3166-2

Example:"string"
vatNostring or null

Tax Identification Number of the business

Example:"string"
isListedOnExchangeboolean or null

Details of company listed on exchange

Example:true
exchangeNamestring or null

Gets the name of the exchange.

Example:"string"
organizationNumberstring or null

Gets the organisation number.

Example:"string"
internalContactstring or null

Gets the internal contact.

Example:"string"
internalEmailstring or null

Gets the internal email.

Example:"string"
internationalScorestring or null

Gets the international score.

createdAtstring, (date-time)

Profile details created time

Example:"2023-08-07T07:12:43.331308Z"
createdByIdinteger, (int32)

Id of the user who created profile

Example:101562008
createdBystring

Name of the user who created profile

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

Profile details last updated time

Example:"2023-08-08T07:16:27.734212Z"
modifiedByIdinteger or null, (int32)

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"
noteCountinteger, (int32)

Count of notes associated with profile details

Example:0
attachmentCountinteger, (int32)

Count of attachment associated with profile details

Example:2
correlationIdstring
Example:"70fd7603-1f75-4de6-8e38-a3c79ac24947"
Response
{
  "profileId": "2770ac31-8d12-4f69-8f93-326e93cd8c34",
  "legalName": "string",
  "tradingName": "string",
  "aliases": [
    "string"
  ],
  "activity": "string",
  "description": "string",
  "contactName": "string",
  "email": "string",
  "website": "string",
  "telephone": "string",
  "turnover": {
    "currencyCode": "eur",
    "amount": 0
  },
  "assetsUnderManagement": {
    "currencyCode": "eur",
    "amount": 0
  },
  "dateOfBirth": "2024-02-27",
  "countryCode": "string",
  "vatNo": "string",
  "isListedOnExchange": true,
  "exchangeName": "string",
  "organizationNumber": "string",
  "internalContact": "string",
  "internalEmail": "string",
  "createdAt": "2023-08-07T07:12:43.331308Z",
  "createdById": 101562008,
  "createdBy": "Amol",
  "modifiedAt": "2023-08-08T07:16:27.734212Z",
  "modifiedById": 101562008,
  "modifiedBy": "Amol",
  "noteCount": 0,
  "attachmentCount": 2,
  "correlationId": "70fd7603-1f75-4de6-8e38-a3c79ac24947"
}