# Create Profile

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

Endpoint: POST /compliance/kyc-protect/profiles
Version: 1.10.9
Security: bearerToken

## Request fields (application/json):

  - `name` (string, required)
    The name of the profile being created. This MUST be unique across your profiles.

  - `type` (string, required)
    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

  - `details` (object)
    Please note the required property in this object.

  - `details.legalName` (string, required)
    Name of the Business or Individual Maximum length is 150 characters
    Example: "Creditsafe Ltd"

  - `details.tradingName` (string)
    Valid for profile type - SoleTrader Maximum length is 150 characters

  - `details.aliases` (string)
    Name of any Aliases Maximum length of each alias is 150 characters

  - `details.activity` (string)
    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"

  - `details.description` (string)
    Description of the business/individual entity Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC
    Example: "Example Free Text"

  - `details.contactName` (string)
    Contact person at the organisation.

  - `details.email` (string)
    Contact email address of the entity
    Example: "example@creditsafe.com"

  - `details.website` (string)
    Website address of the entity Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC
    Example: "www.creditsafe.com"

  - `details.telephone` (string)
    Telephone number of the entity. Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC

  - `details.turnover` (object)

  - `details.turnover.currencyCode` (string)
    The currency the amount is in
    Enum: "eur", "gbp", "usd", "cny", "cad", "aud", "nzd", "inr", "jpy", "chf", "zar", "dkk", "sek", "nok"

  - `details.turnover.amount` (integer)
    Total Turnover Figure

  - `details.assetsUnderManagement` (object)

  - `details.assetsUnderManagement.amount` (integer)
    The total value of the assets under management

  - `details.organizationNumber` (string)
    Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC
    Example: "12345678"

  - `details.internalContact` (string)
    Internal contact name to contact regarding this profile, Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC.

  - `details.internalEmail` (string)
    Internal email address to contact regarding this profile. Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC

  - `details.dateOfBirth` (string)
    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"

  - `details.countryCode` (string)
    Two-letter country code ISO-3166-2. Valid for the profile types Individual and SoleTrader
    Example: "GB"

  - `details.vatNo` (string)
    Tax Identification Number of the business Valid for the profile types Company, Partnership, OtherEntity and PLC
    Example: "GB12345678"

  - `details.isListedOnExchange` (boolean)
    Property valid for profile type PLC

  - `details.exchangeName` (string)
    Property valid for profile type PLC

## Response 201 fields (application/json):

  - `id` (string)
    Id of the Profile

  - `name` (string)
    Name of the Profile

  - `riskRating` (string)
    Risk rating given to profile (notApplicable, veryLow, low, medium, high, veryHigh)

  - `status` (string)
    Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)

  - `type` (string)
    Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)

  - `internalId` (string,null)
    Internal Id given to profile by customer

  - `assignedToId` (integer,null)
    Id of the user assigned to the profile

  - `assignedTo` (string,null)
    Name of the user assigned to the profile

  - `safeNumber` (string,null)
    safe number of the business linked to the profile

  - `companyId` (string,null)
    company id of the business linked to the profile

  - `formationDate` (string,null)
    Formation date of the business linked to the profile

  - `createdAt` (string)
    Profile created time

  - `createdById` (integer)
    Id of the user who created the profile

  - `createdBy` (string)
    Name of the user who created the profile

  - `modifiedAt` (string,null)
    Profile last updated time

  - `modifiedById` (integer,null)
    Id of the user who last modified the profile

  - `modifiedBy` (string,null)
    Name of the user who last modified the profile

  - `kycApprovedAt` (string,null)
    Date when the profile got approved

  - `kycReviewOn` (string,null)
    Date when profile is to be reviewed

  - `kycStatusUpdatedOn` (string,null)
    Date when the profile status was last updated

  - `kycComments` (string,null)
    Profile comments

  - `noteCount` (integer)
    Count of notes associated with profile

  - `attachmentCount` (integer)
    Count of attachments associated with profile

  - `keyPartyCount` (integer)
    Count of key parties associated with profile

  - `uboCount` (integer)
    Count of UBOs associated with profile

  - `openAlertCount` (integer)
    Count of Open Alerts

  - `modeOfCreation` (string)
    Mode of profile creation (manual, import)

  - `importStatus` (string,null)
    Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)

  - `isLocked` (boolean)
    Value indicating whether the profile is locked

  - `details` (object)

  - `details.profileId` (string)
    Id of the profile

  - `details.legalName` (string)
    Name of the business/individual

  - `details.tradingName` (string,null)
    Trading name of the entity

  - `details.aliases` (array)
    Alias names given for the entity

  - `details.activity` (string,null)
    Activity of the business e.g., NAICS/SIC codes

  - `details.description` (string,null)
    Description of the entity

  - `details.contactName` (string,null)
    Contact person name

  - `details.email` (string,null)
    Contact email address

  - `details.website` (string,null)
    Entity website address

  - `details.telephone` (string,null)
    Contact telephone number

  - `details.turnover` (object)
    Turnover

  - `details.turnover.currencyCode` (string,null)
    Currency Code(eur, gbp, usd, cny, cad, aud, nzd, inr, jpy, chf, zar, dkk, sek, nok).

  - `details.turnover.amount` (number,null)
    Turnover Amount.

  - `details.assetsUnderManagement` (object)
    Assets Under Management

  - `details.assetsUnderManagement.amount` (number,null)
    Assets Under Management Amount.

  - `details.dateOfBirth` (string,null)
    Date of birth of the individual

  - `details.countryCode` (string,null)
    Two-letter country code ISO-3166-2

  - `details.vatNo` (string,null)
    Tax Identification Number of the business

  - `details.isListedOnExchange` (boolean,null)
    Details of company listed on exchange

  - `details.exchangeName` (string,null)
    Gets the name of the exchange.

  - `details.organizationNumber` (string,null)
    Gets the organisation number.

  - `details.internalContact` (string,null)
    Gets the internal contact.

  - `details.internalEmail` (string,null)
    Gets the internal email.

  - `details.internationalScore` (string,null)
    Gets the international score.

  - `details.createdAt` (string)
    Profile details created time

  - `details.createdById` (integer)
    Id of the user who created profile

  - `details.createdBy` (string)
    Name of the user who created profile

  - `details.modifiedAt` (string,null)
    Profile details last updated time

  - `details.noteCount` (integer)
    Count of notes associated with profile details

  - `details.attachmentCount` (integer)
    Count of attachment associated with profile details

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 409 fields (application/json):

  - `correlationId` (string)
    The unique identifier. (A UUID specified by RFC4122).

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected