--- title: Create an entity slug: import-test-pdf/wMK7-create-an-entity createdAt: 2025-10-27T13:00:23.923Z --- { "id": "Hk1Bkz8T4YcVcd8GD1Koc", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/clients/{entityIdentifier}/entities", "description": "RS Provisioning Production API" } ], "name": "Create an entity", "description": "Create an entity", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "entityIdentifier", "type": "string", "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." } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "Model for creating an entity", "customType": "CreateEntity", "schema": [ { "name": "entityKdm", "kind": "required", "type": "object", "description": "Model for entity KDM", "modelRef": "#/components/schemas/EntityKdmDetail", "customType": "EntityKdmDetail", "schema": [ { "name": "status", "kind": "required", "type": "string", "description": "The status of the product", "example": "" }, { "name": "shortName", "kind": "optional", "type": "string", "description": "Short name to identify the entity", "example": "shortName" }, { "name": "legalName", "kind": "optional", "type": "string", "description": "If reportable id is of type LEID then GLEIF legal name", "example": "legalName" }, { "name": "ASICSmallScaleBuySideIndicator", "kind": "optional", "type": "boolean", "description": "If applicable, an indicator that the Reporting Entity is making the report as a Small-scale Buy-side Entity\n", "example": true }, { "name": "CADesignation", "kind": "optional", "type": "array", "description": "Indication whether Entity is a derivatives dealer, non derivatives dealer or a clearing agent\n
x-extensible-enum: \n - CA\n - DD\n - NON-DD/CA\n\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "string", "description": "", "example": "CA" } ] }, { "name": "CALocalCounterparty", "kind": "optional", "type": "array", "description": "Province(s) of Entity where they are a local counterparty\n
x-extensible-enum: \n - AB\n - BC\n - MB\n - NB\n - NL\n - NS\n - NT\n - NU\n - ON\n - PE\n - QC\n - SK\n - YT\n\n", "example": "[\"AB\",\"BC\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "CFTCClearingExceptionsAndExemptions", "kind": "optional", "type": "array", "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.\n
x-extensible-enum: \n - NOAL\n - SMBK\n - COOP\n - ENDU\n - AFFL\n - OTHR\n\n", "example": "[\"NOAL\",\"SMBK\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "CFTCConduitAffiliateUSPerson", "kind": "optional", "type": "boolean", "description": "Is the party a Conduit Affiliate of a US Person per CFTC rules?\n", "example": true }, { "name": "CFTCDesignation", "kind": "optional", "type": "array", "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.\n
x-extensible-enum: \n - NON-SD/MSP/DCO\n - SD\n - MSP\n - DCO\n\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "string", "description": "", "example": "SD" } ] }, { "name": "CFTCFederalEntityIndicator", "kind": "optional", "type": "boolean", "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.\n", "example": true }, { "name": "CFTCFinancialEntityIndicator", "kind": "optional", "type": "boolean", "description": "Indicator of whether My Entity is a financial entity as defined in CEA §2(h)(7)(C)\n", "example": true }, { "name": "CFTCGuaranteedAffiliateUSPerson", "kind": "optional", "type": "boolean", "description": "Can be inferred by looking at the USP status of the entity's guarantor\n", "example": true }, { "name": "CFTCInternationalFinancialInstitutionIndicator", "kind": "optional", "type": "boolean", "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.\n", "example": true }, { "name": "CFTCLimitedPurposeDesignation", "kind": "optional", "type": "string", "description": "Where an entity's swap dealer designation is limited to certain asset classes, the asset classes\n
x-extensible-enum: \n - CRDT\n - COMM\n - INTR\n - CURR\n - EQUI\n\n", "example": "CRDT" }, { "name": "CFTCSmallLocalPresenceIndicator", "kind": "optional", "type": "boolean", "description": "Does the amount of business in this local jurisdiction exceed 5% of the total business for the parent entity?\n", "example": true }, { "name": "CFTCUSPerson", "kind": "optional", "type": "boolean", "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.\n", "example": true }, { "name": "country", "kind": "optional", "type": "string", "description": "The country of the legal entity identified in the Reportable ID field\n", "example": "US" }, { "name": "droitEnergyOperatorIndicator", "kind": "optional", "type": "boolean", "description": "Whether a party is an operator or administrator of an energy transmission grid, energy balancing mechanism or pipeline network\n", "example": true }, { "name": "droitEstablishedIn", "kind": "optional", "type": "array", "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\"].\n
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\n", "example": "[\"US\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "droitForeignBranchUSPersonIndicator", "kind": "optional", "type": "boolean", "description": "Whether the party is a non-US office of a US bank\n", "example": true }, { "name": "droitUltimateParentEntityType", "kind": "optional", "type": "string", "description": "Ultimate parent entity classification of the party\n
x-extensible-enum: \n - NOT_APPLICABLE\n - OTHER\n - US_BANK\n - US_BANK_HOLDING_COMPANY\n - US_FINANCIAL_HOLDING_COMPANY\n - US_MAJOR_SWAP_PARTICIPANT\n - US_SWAP_DEALER\n\n", "example": "CONTRAPARTY" }, { "name": "entityType", "kind": "optional", "type": "string", "description": "Indicates the Type of Entity (My Entity, Other Entity) which the Static Data relates to\n", "example": "MY_ENTITY" }, { "name": "ESMABISIndicator", "kind": "optional", "type": "boolean", "description": "The Bank for International Settlements, i.e. \"EMIR Article 1(4)(b) Entity\" in the ISDA EMIR Classification Letter\n", "example": true }, { "name": "ESMACentralBankOrPublicDebtManagerIndicator", "kind": "optional", "type": "boolean", "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.\n", "example": true }, { "name": "ESMACorporateSector", "kind": "optional", "type": "array", "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: \n - ‘INVF’ - Investment firm authorized in accordance with Directive 2014/65/EU of the European Parliament and of the Council1;\n - ‘CDTI’ - Credit institution authorised in accordance with Directive 2013/36/EU of the European Parliament and of the Council2;\n - ‘INUN’ - an insurance undertaking or reinsurance undertaking authorised in accordance with Directive 2009/138/EC of the European Parliament and of the Council3;\n - ‘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;\n - ‘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;\n - ‘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;\n - ‘CSDS’ - a central securities depository authorised in accordance with Regulation (EU) No 909/2014 of the European Parliament and of the Council7;\n

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:
\n - ‘A’ - Agriculture, forestry and fishing;\n - ‘B’ - Mining and quarrying;\n - ‘C’ - Manufacturing;\n - ‘D’ - Electricity, gas, steam and air conditioning supply;\n - ‘E’ - Water supply, sewerage, waste management and remediation activities;\n - ‘F’ - Construction;\n - ‘G’ - Wholesale and retail trade, repair of motor vehicles and motorcycles;\n - ‘H’ - Transportation and storage;\n - ‘I’ - Accommodation and food service activities;\n - ‘J’ - Information and communication;\n - ‘K’ - Financial and insurance activities;\n - ‘L’ - Real estate activities;\n - ‘M’ - Professional, scientific and technical activities;\n - ‘N’ - Administrative and support service activities;\n - ‘O’ - Public administration and defence; compulsory social security;\n - ‘P’ - Education;\n - ‘Q’ - Human health and social work activities;\n - ‘R’ - Arts, entertainment and recreation;\n - ‘S’ - Other service activities;\n - ‘T’ - Activities of households as employers; undifferentiated goods – and services – producing activities of households for own use;\n - ‘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.\n\n
x-extensible-enum:\n - A\n - AIFD\n - B\n - C\n - CDTI\n - CSDS\n - D\n - E\n - F\n - G\n - H\n - I\n - INUN\n - INVF\n - J\n - K\n - L\n - M\n - N\n - O\n - ORPI\n - P\n - Q\n - R\n - S\n - T\n - U\n - UCIT\n\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AIFD\",\"B\",\"C\",\"CDTI\",\"CSDS\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "ESMAEquivalentReportingIndicator", "kind": "optional", "type": "boolean", "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\n", "example": true }, { "name": "ESMAExceedsClearingThreshold", "kind": "optional", "type": "array", "description": "If Entity exceeds the clearing threshold per asset class. Will default to false if asset class is not selected.\n
x-extensible-enum: \n - COMMODITY\n - EQUITY\n - FOREIGN_EXCHANGE\n - INTEREST_RATE\n - NFC_PLUS\n - NOT_APPLICABLE\n - UNKNOWN\n\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"CRDT\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "ESMAExemptedForeignCentralBankIndicator", "kind": "optional", "type": "boolean", "description": "Central banks and public debt management bodies in Japan, the U.S.A, Australia, Canada, Hong Kong, Mexico, Singapore, Switzerland\n", "example": true }, { "name": "ESMANatureOfCounterparty", "kind": "optional", "type": "string", "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.\n
- F = Financial Counterparty - N = Non-Financial Counterparty - C = Central Counterparty - O = Other\n
x-extensible-enum:\n - F\n - N\n - C\n - O\n\n", "example": "F" }, { "name": "ESMAParentFinancialCounterpartyIndicator", "kind": "optional", "type": "boolean", "description": "The Non-financial Counterparty has a parent undertaking that is a Financial Counterparty for the purposes of intragroup exemption from reporting\n", "example": true }, { "name": "ESMAReportingObligation", "kind": "optional", "type": "boolean", "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\n", "example": true }, { "name": "ESMAThirdCountryIndicator", "kind": "optional", "type": "boolean", "description": "Whether an entity is a Third Country Entity (not established in the EU) under EMIR\n", "example": true }, { "name": "internalIdentifier", "kind": "required", "type": "string", "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.\n", "example": "27ID" }, { "name": "NPID", "kind": "optional", "type": "array", "description": "National Product Identifier\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "string", "description": "", "example": "NPID" } ] }, { "name": "LEID", "kind": "optional", "type": "array", "description": "Legal Entity Identifier\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "string", "description": "", "example": "FAKE0022222222222200" } ] }, { "name": "MIC", "kind": "optional", "type": "array", "description": "Market Identifier Code\n", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "string", "description": "", "example": "MIC" } ] }, { "name": "interAffiliate", "kind": "optional", "type": "array", "description": "Indicate whether the transaction is between two affiliated entities ", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "boolean", "description": "", "example": true } ] }, { "name": "CFTCReportingEntity", "kind": "optional", "type": "string", "description": "Indicates if the Other Entity or My Entity are always the reporting entity to the repository or if an industry standard is used.\n
x-extensible-enum: \n - MY_ENTITY\n - OTHER_ENTITY\n - ISDA_WATERFALL\n - ENTITY_RESPONSIBLE_FOR_REPORTING\n\n", "modelRef": "#/components/schemas/ReportingEntity", "customType": "ReportingEntity", "schema": [] }, { "name": "CAAffiliateOfCADealer", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "boolean", "description": "", "example": true } ] }, { "name": "CACanadianAffiliatedPersonLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CACanadianPersonLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CACanadianSpecialEntity", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "CAClearingExemption", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "[\"NOAL\",\"SMBK\"]", "itemDefault": "" } ] }, { "name": "CADeemedDealerLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CAISDACanadaReportingAgreementIndicator", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "boolean", "description": "", "example": true } ] }, { "name": "droitCACanadianCommoditiesCommercialIntent", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "boolean", "description": "", "example": true } ] }, { "name": "CAProvinceOrTerritory", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CARegisteredDealerLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CAReportingObligation", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "boolean", "description": "", "example": true } ] }, { "name": "droitNegAffAgreementProvider", "kind": "optional", "type": "array", "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.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "string", "description": "", "example": true } ] }, { "name": "droitPartyRole", "kind": "optional", "type": "string", "description": "A type describing a role played by a party in one or more transactions, e.g. ExecutingBroker, PrimeBroker, PrimeBrokerClient, etc.", "example": "both" }, { "name": "individualIndicator", "kind": "optional", "type": "boolean", "description": "Indicator that the entity is an individual", "example": "" }, { "name": "masterAgreementType", "kind": "optional", "type": "array", "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.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] } ] }, { "name": "masterAgreementVersion", "kind": "optional", "type": "array", "description": "The version of the master agreement, if used for the reported transaction. ", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] } ] }, { "name": "CAQualifiedReportingCounterpartyIndicator", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "smallCommodityNotionalIndicator", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "CAClearingAgencyAffiliateLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CAClearingAgencyLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CAIndividualLocalities", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "", "example": "2020-01-01" }, { "name": "value", "kind": "optional", "type": "array", "description": "", "example": "[\"AB\",\"ON\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "CAFinancialEntityIndicator", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "CAFinancialInstitutionIndicator", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "CAInvestmentFundIndicator", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "CAListedForeignBankIndicator", "kind": "optional", "type": "boolean", "description": "", "example": "" } ] } ], "modelRef": "#/components/schemas/CreateEntity", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "202", "description": "Entity has been accepted", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "405", "description": "Method Not Allowed", "jsonExample": "", "isExpanded": true }, { "statusCode": "406", "description": "Not Acceptable", "jsonExample": "", "isExpanded": true }, { "statusCode": "415", "description": "Unsupported Media Type", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"entityKdm\": {\n \"status\": \"\",\n \"internalIdentifier\": \"27ID\"\n }\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"entityKdm\": {\n \"status\": \"\",\n \"internalIdentifier\": \"27ID\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"entityKdm\": {\n \"status\": \"\",\n \"internalIdentifier\": \"27ID\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/entities\"\n\npayload = json.dumps({\n \"entityKdm\": {\n \"status\": \"\",\n \"internalIdentifier\": \"27ID\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-202", "language": "202", "code": "// Entity has been accepted\n{\n \"identifier\": \"EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-404", "language": "404", "code": "// Not Found\n" }, { "id": "response-5-405", "language": "405", "code": "// Method Not Allowed\n" }, { "id": "response-6-406", "language": "406", "code": "// Not Acceptable\n" }, { "id": "response-7-415", "language": "415", "code": "// Unsupported Media Type\n" }, { "id": "response-8-500", "language": "500", "code": "// Internal Server Error\n" }, { "id": "response-9-504", "language": "504", "code": "// Gateway Timeout\n" }, { "id": "response-10-default", "language": "default", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-202" } }, "children": [ { "text": "" } ] }