Create an entity

1 min

POST

https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities

Create an entity

Path Parameters

entityIdentifierstring<uuid>required
Example
3AE803B1-5765-481D-BFAB-D176679D7D8C
Description
Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.

Body Parameters

bodyCreateEntity
Description
Model for creating an entity
- entityKdmEntityKdmDetailrequired
  Description
  Model for entity KDM
  - statusstringrequired
    Description
    The status of the product
  - shortNamestring
    Example
    shortName
    Description
    Short name to identify the entity
  - legalNamestring
    Example
    legalName
    Description
    If reportable id is of type LEID then GLEIF legal name
  - ASICSmallScaleBuySideIndicatorboolean
    Example
    true
    Description
    If applicable, an indicator that the Reporting Entity is making the report as a Small-scale Buy-side Entity
  - CADesignationobject[]
    Description
    Indication whether Entity is a derivatives dealer, non derivatives dealer or a clearing agent
    x-extensible-enum: - CA - DD - NON-DD/CA
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring
      Example
      CA
  - CALocalCounterpartystring[]
    Example
    [ "AB", "BC" ]
    Description
    Province(s) of Entity where they are a local counterparty
    x-extensible-enum: - AB - BC - MB - NB - NL - NS - NT - NU - ON - PE - QC - SK - YT
  - CFTCClearingExceptionsAndExemptionsstring[]
    Example
    [ "NOAL", "SMBK" ]
    Description
    Identifies the type of clearing exception or exemption that the My entity has elected. All applicable exceptions and exemptions must be selected. The values may be repeated as applicable.
    x-extensible-enum: - NOAL - SMBK - COOP - ENDU - AFFL - OTHR
  - CFTCConduitAffiliateUSPersonboolean
    Example
    true
    Description
    Is the party a Conduit Affiliate of a US Person per CFTC rules?
  - CFTCDesignationobject[]
    Description
    Indication whether Entity is a registered swap dealer, major swap participant, DCO, or non-SD/MSP/DCO for the purpose of the submitted swap.
    x-extensible-enum: - NON-SD/MSP/DCO - SD - MSP - DCO
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring
      Example
      SD
  - CFTCFederalEntityIndicatorboolean
    Example
    true
    Description
    Indicator of whether Entity is: One of the following entities: An entity established pursuant to federal law, including, but not limited to, the following: An “agency” as defined in 5 U.S.C. § 551(1), a federal instrumentality, or a federal authority; A government corporation (examples: as such term is defined in 5 U.S.C. § 103(1) or in 31 U.S.C. § 9101); A government-sponsored enterprise (examples: as such term is defined in 2 U.S.C. § 622(8)); A federally funded research and development center on the master list referenced in 48 CFR 35.017-6; and An executive department listed in 5 U.S.C. § 101; or An entity chartered pursuant to federal law after formation (examples: an organization listed in title 36 of the U.S. Code); or An entity that was established by, or at the direction of, one or more of the entities listed in clause (1), or has an ultimate parent listed in its LEI reference data that is an entity listed in clause (1) or in the first part of this clause (2). Notwithstanding the foregoing, the Entity federal entity indicator data element does not include federally chartered depository institutions.
  - CFTCFinancialEntityIndicatorboolean
    Example
    true
    Description
    Indicator of whether My Entity is a financial entity as defined in CEA §2(h)(7)(C)
  - CFTCGuaranteedAffiliateUSPersonboolean
    Example
    true
    Description
    Can be inferred by looking at the USP status of the entity's guarantor
  - CFTCInternationalFinancialInstitutionIndicatorboolean
    Example
    true
    Description
    Is the party an IFI and consequently determined by the CFTC to be exempted from clearing? This is driven by association with an explicit enumerated list coming from the CFTC and stored in separate static data.
  - CFTCLimitedPurposeDesignationstring
    Example
    CRDT
    Description
    Where an entity's swap dealer designation is limited to certain asset classes, the asset classes
    x-extensible-enum: - CRDT - COMM - INTR - CURR - EQUI
  - CFTCSmallLocalPresenceIndicatorboolean
    Example
    true
    Description
    Does the amount of business in this local jurisdiction exceed 5% of the total business for the parent entity?
  - CFTCUSPersonboolean
    Example
    true
    Description
    (by subsection in new Rule 23.23(a)(23)) U.S. Person means any person that is: (A) a natural person resident in the United States; (B) an estate of a decedent who was a resident of the United States at the time of death; (C) a partnership, corporation, trust, investment vehicle or other legal person organized, incorporated or established under the laws of the United States or having its principal place of business in the United States; (D) an account (whether discretionary or non‑discretionary) of a U.S. Person; or (E) an estate of a decedent who was a resident of the United States at the time of death. Until December 31, 2027, a person may continue to classify counterparties as U.S. Persons based on: representations made pursuant to the “U.S. Person” definition in § 23.160(a)(10) prior to the effective date of the new definition; or representations made pursuant to the interpretation of the term “U.S. Person” in the Cross-Border Guidance prior to the effective date of the new definition.
  - countrystring
    Example
    US
    Description
    The country of the legal entity identified in the Reportable ID field
  - droitEnergyOperatorIndicatorboolean
    Example
    true
    Description
    Whether a party is an operator or administrator of an energy transmission grid, energy balancing mechanism or pipeline network
  - droitEstablishedInstring[]
    Example
    [ "US" ]
    Description
    Two-letter codes for countries, provinces, regions, etc, under the laws of which an entity is established, using the ISO-3166 standards. This attribute can take on a single string value, such as "AU" for a party established under the laws of Australia. Or when multiple levels of regulations are relevant, this attribute can be populated with an array of string codes to signify different levels of granularity. For example, when a party is established in Canada, the specific provincial codes are also necessary, e.g. ["CA","ON"] for Ontario. An example for a party established in one of the European Union member states can be ["BE","EU"].
    x-extensible-enum: AB, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BC, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, EU, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MB, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NB, NC, NE, NF, NG, NI, NL, NO, NP, NR, NS, NT, NU, NZ, OM, ON, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QC, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
  - droitForeignBranchUSPersonIndicatorboolean
    Example
    true
    Description
    Whether the party is a non-US office of a US bank
  - droitUltimateParentEntityTypestring
    Example
    CONTRAPARTY
    Description
    Ultimate parent entity classification of the party
    x-extensible-enum: - NOT_APPLICABLE - OTHER - US_BANK - US_BANK_HOLDING_COMPANY - US_FINANCIAL_HOLDING_COMPANY - US_MAJOR_SWAP_PARTICIPANT - US_SWAP_DEALER
  - entityTypestring
    Example
    MY_ENTITY
    Description
    Indicates the Type of Entity (My Entity, Other Entity) which the Static Data relates to
  - ESMABISIndicatorboolean
    Example
    true
    Description
    The Bank for International Settlements, i.e. "EMIR Article 1(4)(b) Entity" in the ISDA EMIR Classification Letter
  - ESMACentralBankOrPublicDebtManagerIndicatorboolean
    Example
    true
    Description
    Any members of the European System of Central Banks or other Member States' bodies performing similar functions or other European Union public bodies charged with or intervening in the management of the public debt, i.e. "EMIR Article 1(4)(a) Entity" in the ISDA EMIR classification letter.
  - ESMACorporateSectorobject[]
    Description
    Nature of Entity's company activities. If the counterparty 1 is a Financial Counterparty, this field shall contain all necessary codes included in the Taxonomy for Financial Counterparties in field 6 of Table 1 of the Annex to [PO please insert reference to C(2022) 3588] and applying to that counterparty. If counterparty 1 is a non - financial counterparty, this field shall contain all necessary codes included in the Taxonomy for Non - financial Counterparties in field 6 of Table 1 of the Annex to [PO please insert reference to C(2022) 3588] and applying to that Counterparty. Where more than one activity is reported, the codes shall be populated in order of the relative importance of the corresponding activities.
    
    Taxonomy for Financial Counterparties: - ‘INVF’ - Investment firm authorized in accordance with Directive 2014/65/EU of the European Parliament and of the Council1; - ‘CDTI’ - Credit institution authorised in accordance with Directive 2013/36/EU of the European Parliament and of the Council2; - ‘INUN’ - an insurance undertaking or reinsurance undertaking authorised in accordance with Directive 2009/138/EC of the European Parliament and of the Council3; - ‘UCIT’ - a UCITS and, where relevant, its management company, authorised in accordance with Directive 2009/65/EC of the European Parliament and of the Council4, unless that UCITS is set up exclusively for the purpose of serving one or more employee share purchase plans; - ‘ORPI’ - an institution for occupational retirement provision (IORP), as defined in point (1) of Article 6 of Directive (EU) 2016/2341 of the European Parliament and of the Council5; - ‘AIFD’ - an alternative investment fund (AIF), as defined in point (a) of Article 4(1) of Directive 2011/61/EU of the European Parliament and of the Council6, which is either established in the Union or managed by an alternative investment fund manager (AIFM) authorised or registered in accordance with that Directive, unless that AIF is set up exclusively for the purpose of serving one or more employee share purchase plans, or unless that AIF is a securitisation special purpose entity as referred to in point (g) of Article 2(3) of Directive 2011/61/EU, and, where relevant, its AIFM established in the Union; - ‘CSDS’ - a central securities depository authorised in accordance with Regulation (EU) No 909/2014 of the European Parliament and of the Council7;
    
    Taxonomy for Non-Financial Counterparties. The categories below correspond to the main sections of NACE classification as defined in Regulation (EC) No 1893/2006 of the European Parliament and of the Council8:
    - ‘A’ - Agriculture, forestry and fishing; - ‘B’ - Mining and quarrying; - ‘C’ - Manufacturing; - ‘D’ - Electricity, gas, steam and air conditioning supply; - ‘E’ - Water supply, sewerage, waste management and remediation activities; - ‘F’ - Construction; - ‘G’ - Wholesale and retail trade, repair of motor vehicles and motorcycles; - ‘H’ - Transportation and storage; - ‘I’ - Accommodation and food service activities; - ‘J’ - Information and communication; - ‘K’ - Financial and insurance activities; - ‘L’ - Real estate activities; - ‘M’ - Professional, scientific and technical activities; - ‘N’ - Administrative and support service activities; - ‘O’ - Public administration and defence; compulsory social security; - ‘P’ - Education; - ‘Q’ - Human health and social work activities; - ‘R’ - Arts, entertainment and recreation; - ‘S’ - Other service activities; - ‘T’ - Activities of households as employers; undifferentiated goods – and services – producing activities of households for own use; - ‘U’ - Activities of extraterritorial organizations and bodies. Where more than one activity is reported, list the codes in order of the relative importance of the corresponding activities. Leave blank in the case of CCPs and other type of counterparties in accordance with Article 1(5) of Regulation (EU) No 648/20129.
    x-extensible-enum: - A - AIFD - B - C - CDTI - CSDS - D - E - F - G - H - I - INUN - INVF - J - K - L - M - N - O - ORPI - P - Q - R - S - T - U - UCIT
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AIFD", "B", "C", "CDTI", "CSDS" ]
  - ESMAEquivalentReportingIndicatorboolean
    Example
    true
    Description
    The third country financial counterparty is subject to a legal regime that has been declared equivalent to EMIR and has agreed to report the derivative contract pursuant to the rules of such third country legal regime
  - ESMAExceedsClearingThresholdobject[]
    Description
    If Entity exceeds the clearing threshold per asset class. Will default to false if asset class is not selected.
    x-extensible-enum: - COMMODITY - EQUITY - FOREIGN_EXCHANGE - INTEREST_RATE - NFC_PLUS - NOT_APPLICABLE - UNKNOWN
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "CRDT" ]
  - ESMAExemptedForeignCentralBankIndicatorboolean
    Example
    true
    Description
    Central banks and public debt management bodies in Japan, the U.S.A, Australia, Canada, Hong Kong, Mexico, Singapore, Switzerland
  - ESMANatureOfCounterpartystring
    Example
    F
    Description
    Indicate if the Entity is a CCP, a financial or a non-financial counterparty or other type of counterparty as defines in Article 2, points 1, 8 and 9, of Regulation (EU) No 648/2012, or an entity as referred to in Article 1, point 5, of that Regulation.
    - F = Financial Counterparty - N = Non-Financial Counterparty - C = Central Counterparty - O = Other
    x-extensible-enum: - F - N - C - O
  - ESMAParentFinancialCounterpartyIndicatorboolean
    Example
    true
    Description
    The Non-financial Counterparty has a parent undertaking that is a Financial Counterparty for the purposes of intragroup exemption from reporting
  - ESMAReportingObligationboolean
    Example
    true
    Description
    Indicator of whether counterparty has the reporting obligation under Regulation (EU) No 648/2012, irrespective of who is responsible and legally liable for its reporting
  - ESMAThirdCountryIndicatorboolean
    Example
    true
    Description
    Whether an entity is a Third Country Entity (not established in the EU) under EMIR
  - internalIdentifierstringrequired
    Example
    27ID
    Description
    Identifier used on submission to link to this record. This ID must be unique and is typically an internal identifier assigned by the submitter.
  - NPIDobject[]
    Description
    National Product Identifier
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring
      Example
      NPID
  - LEIDobject[]
    Description
    Legal Entity Identifier
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring
      Example
      FAKE0022222222222200
  - MICobject[]
    Description
    Market Identifier Code
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring
      Example
      MIC
  - interAffiliateobject[]
    Description
    Indicate whether the transaction is between two affiliated entities
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valueboolean
      Example
      true
  - CFTCReportingEntityReportingEntity
    Description
    Indicates if the Other Entity or My Entity are always the reporting entity to the repository or if an industry standard is used.
    x-extensible-enum: - MY_ENTITY - OTHER_ENTITY - ISDA_WATERFALL - ENTITY_RESPONSIBLE_FOR_REPORTING
  - CAAffiliateOfCADealerobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valueboolean
      Example
      true
  - CACanadianAffiliatedPersonLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CACanadianPersonLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CACanadianSpecialEntityboolean
  - CAClearingExemptionobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
  - CADeemedDealerLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CAISDACanadaReportingAgreementIndicatorobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valueboolean
      Example
      true
  - droitCACanadianCommoditiesCommercialIntentobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valueboolean
      Example
      true
  - CAProvinceOrTerritoryobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CARegisteredDealerLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CAReportingObligationobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valueboolean
      Example
      true
  - droitNegAffAgreementProviderobject[]
    Description
    Negative affirmation provider for the party. Given a fixed Contraparty, only the Counterparty should have this input populated. This is to represent the designated negative affirmation provider between the pair in their corresponding Master Agreement. Attribute may take the value of "Contraparty" or "Counterparty. When it does not apply, provide as null.
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring
      Example
      true
  - droitPartyRolestring
    Example
    both
    Description
    A type describing a role played by a party in one or more transactions, e.g. ExecutingBroker, PrimeBroker, PrimeBrokerClient, etc.
  - individualIndicatorboolean
    Description
    Indicator that the entity is an individual
  - masterAgreementTypeobject[]
    Description
    Negative affirmation provider for the party. Given a fixed Contraparty, only the Counterparty should have this input populated. This is to represent the designated negative affirmation provider between the pair in their corresponding Master Agreement. Attribute may take the value of "Contraparty" or "Counterparty. When it does not apply, provide as null.
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuemap<string, string>
  - masterAgreementVersionobject[]
    Description
    The version of the master agreement, if used for the reported transaction.
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuemap<string, string>
  - CAQualifiedReportingCounterpartyIndicatorboolean
  - smallCommodityNotionalIndicatorboolean
  - CAClearingAgencyAffiliateLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CAClearingAgencyLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CAIndividualLocalitiesobject[]
    - effectiveDatestring<date>
      Example
      2020-01-01
    - valuestring[]
      Example
      [ "AB", "ON" ]
  - CAFinancialEntityIndicatorboolean
  - CAFinancialInstitutionIndicatorboolean
  - CAInvestmentFundIndicatorboolean
  - CAListedForeignBankIndicatorboolean

Responses

202Entity has been accepted

object
- identifierstring<uuid>
  Example
  EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

415Unsupported Media Type

500Internal Server Error

504Gateway Timeout

defaultInternal Server Error

curl

curl --request POST \
     --url https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "entityKdm": {
     "status": "",
     "internalIdentifier": "27ID"
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "entityKdm": {
      "status": "",
      "internalIdentifier": "27ID"
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "entityKdm": {
      "status": "",
      "internalIdentifier": "27ID"
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities"

payload = json.dumps({
   "entityKdm": {
      "status": "",
      "internalIdentifier": "27ID"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

202

// Entity has been accepted
{
  "identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB"
}

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

405

// Method Not Allowed

406

// Not Acceptable

415

// Unsupported Media Type

500

// Internal Server Error

504

// Gateway Timeout

default

// Internal Server Error