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

Update Profile Details

Request

Updates the details of profile by the profileId.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
Bodyapplication/json
legalNamestring or nullrequired

Name of the Business or Individual
Maximum length is 150 characters

Example:"Creditsafe Ltd"
tradingNamestring or null

Valid for profile type - SoleTrader
Maximum length is 150 characters

Example:null
aliasesArray of strings or null

Name of any Aliases
Maximum length of each alias is 150 characters

Example:null
activitystring or null

Activity of the Business e.g. NAIC S/SIC Codes
Valid for profile types - Trust, Company, Partnership, OtherEntity and PLC
Maximum length of activity is 150 characters

Example:"62409"
descriptionstring or null

Description of the business/individual entity
Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

Example:"Example Free Text"
contactNamestring or null

Contact person at the organisation.

Example:null
emailstring or null

Contact email address of the entity

Example:"example@creditsafe.com"
websitestring or null

Website address of the entity
Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

Example:"www.creditsafe.com"
telephonestring or null

Telephone number of the entity.
Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

Example:null
turnoverobject
assetsUnderManagementobject
organizationNumberstring or null

Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC

Example:"12345678"
internalContactstring or null

Internal contact name to contact regarding this profile,
Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC.

Example:null
internalEmailstring or null

Internal email address to contact regarding this profile.
Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC

Example:null
dateOfBirthstring or null, (date)

Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future
Valid for the profile types Individual and SoleTrader

Example:"2024-03-25"
countryCodestring or null

Two-letter country code ISO-3166-2.
Valid for the profile types Individual and SoleTrader

Example:"GB"
vatNostring or null

Tax Identification Number of the business
Valid for the profile types Company, Partnership, OtherEntity and PLC

Example:"GB12345678"
isListedOnExchangeboolean or null

Property valid for profile type PLC

Example:null
exchangeNamestring or null

Property valid for profile type PLC

Example:null
curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/details \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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

Bodyapplication/json
profileIdstring, (uuid)

Id of the profile

legalNamestring

Name of the business/individual

tradingNamestring

Trading name of the entity

aliasesArray of strings

Alias names given for the entity

activitystring

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

descriptionstring

Description of the entity

contactNamestring

Contact person name

emailstring

Contact email address

websitestring

Entity website address

telephonestring

Contact telephone number

turnoverobject
assetsUnderManagementobject
dateOfBirthstring, (date)

Date of birth of the individual

countryCodestring

Two-letter country code ISO-3166-2

vatNostring

Tax Identification Number of the business

isListedOnExchangeboolean

Details of company listed on exchange

exchangeNamestring

Gets the name of the exchange.

organizationNumberstring

Gets the organisation number.

internalContactstring

Gets the internal contact.

internalEmailstring

Gets the internal email.

internationalScorestring

Gets the international score.

createdAtstring, (date-time)

Profile details created time

createdByIdinteger, (int32)

Id of the user who created profile

createdBystring

Name of the user who created profile

modifiedAtstring, (date-time)

Profile details last updated time

modifiedByIdinteger, (int32)

Id of the user who last modified the profile

modifiedBystring

Name of the user who last modified the profile

noteCountinteger, (int32)

Count of notes associated with profile details

attachmentCountinteger, (int32)

Count of attachment associated with profile details

Response
{
  "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.1
  },
  "assetsUnderManagement": {
    "currencyCode": "string",
    "amount": 0.1
  },
  "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
}