Synchronize the relationships

1 min

PUT

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

Synchronize a number of relationships from another environment.

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

bodySynchronizeRelationshipsRequest
Description
The synchronize relationships request containing one or more relationships to synchronize
- relationshipsRelationshipSyncInfo[]
  Description
  The relationship synchronization information
  - relationshipKdmRelationshipKdmrequired
    Description
    Model for relationship KDM
    - statusstringrequired
      Description
      The status of the relationship
    - interAffiliateboolean
      Description
      Indicate whether the transaction is between two affiliated entities
    - myEntityInternalIdentifierstringrequired
      Example
      27ID
      Description
      "Internal identifier of My Entity on behalf of whom this report is being made. This identifier is used to link to My Entity static data. In the case of an allocated derivative transaction executed by a fund manager on behalf of a fund, the fund, and not the fund manager is reported as My Entity."
    - otherEntityInternalIdentifierstringrequired
      Example
      27ID
      Description
      "Internal identifier of the Other Entity to an OTC derivative transaction. This identifier is used to link submissions to the Other Entity static data configurations. In the case of an allocated derivative transaction executed by a fund manager on behalf of a fund, the fund, and not the fund manager is reported. "
    - UTICreatorobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string>
    - myEntityCFTCPrivacyLawIdentifierstring
      Description
      My Entity's Privacy Law Identifier when transacting against Other Entity, where applicable
    - CFTCReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - SECSBRReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - EMIREUMyReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - EMIREUOtherReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - EMIRUKMyReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - EMIRUKOtherReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - CAReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - ASICMyReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - ASICOtherReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - MASMyReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - MASOtherReportingEntityobject[]
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valueReportingEntity
        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
    - otherEntityCFTCPrivacyLawIdentifierstring
      Description
      Other Entity's Privacy Law Identifier when transacting against My Entity, where applicable
    - masterAgreementTypeobject[]
      Description
      The type of master agreement, if used for the reported transaction.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string>
    - otherMasterAgreementTypeobject[]
      Description
      Name of the master agreement. This field shall only be completed where ‘OTHR’ is reported in field 34 in this table.
      - 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>
    - collateralisationCategoryobject[]
      Description
      Indicator of whether a collateral agreement (or collateral agreements) between the counterparties exists (uncollateralised/partially collateralised/one-way collateralised/fully collateralised). This data element is provided for each transaction or each portfolio, depending on whether the collateralisation is performed at the transaction or portfolio level, and is applicable to both cleared and uncleared transactions.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string>
    - EMIRUKMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIRUKOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIRUKMyEntityTransactionListedDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIRUKOtherEntityTransactionListedDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - SECSBRMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - SECSBROtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CAMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CAOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - SECSBRMyEntityPublicDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - SECSBROtherEntityPublicDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CAMyEntityPublicDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CAOtherEntityPublicDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CFTCMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CFTCOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CFTCMyEntityPublicDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - CFTCOtherEntityPublicDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIREUMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - ASICOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIREUMyEntityTransactionListedDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIREUOtherEntityTransactionListedDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - ACERREMITMyEntityDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - ACERREMITOtherEntityDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - ASICMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - EMIREUOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - MASMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - MASOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - HKMAMyEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - HKMAOtherEntityTransactionDroitFulfilledObligationsobject[]
      Description
      Indicates the Droit reporting obligation determinations which should result in a regulatory message being created from the Other Entity's perspective.
      - effectiveDatestring<date>
        Example
        2020-01-01
      - valuemap<string, string[]>
    - droitPartyRolestring
      Example
      Both
      Description
      A type describing a role played by a party in one or more transactions, e.g. ExecutingBroker, PrimeBroker, PrimeBrokerClient, etc.

Responses

202The relationships synchronization request has been accepted for processing.

SynchronizeRelationshipsResponse
Description
The synchronize relationships response
- relationshipsRelationshipSynchronizationResult[]
  Description
  The relationship synchronization result
  - relationshipIdentifierstring<uuid>
    Example
    EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    Description
    The identifier of the relationship
  - commentstring
    Example
    Created
    Description
    Information on the synchronization result

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 PUT \
     --url https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/relationships/synchronizations \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "relationships": [
     {
     "relationshipKdm": {
     "status": "",
     "myEntityInternalIdentifier": "27ID",
     "otherEntityInternalIdentifier": "27ID"
     }
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "relationships": [
      {
         "relationshipKdm": {
            "status": "",
            "myEntityInternalIdentifier": "27ID",
            "otherEntityInternalIdentifier": "27ID"
         }
      }
   ]
});

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

fetch("https://provisioning.rs.int.{environment}.korfinancial.com/clients/{entityIdentifier}/relationships/synchronizations", 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}/relationships/synchronizations")

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

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "relationships": [
      {
         "relationshipKdm": {
            "status": "",
            "myEntityInternalIdentifier": "27ID",
            "otherEntityInternalIdentifier": "27ID"
         }
      }
   ]
})

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

python

import requests
import json

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

payload = json.dumps({
   "relationships": [
      {
         "relationshipKdm": {
            "status": "",
            "myEntityInternalIdentifier": "27ID",
            "otherEntityInternalIdentifier": "27ID"
         }
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

202

// The relationships synchronization request has been accepted for processing.
{
  "relationships": [
    {
      "relationshipIdentifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
      "comment": "Created"
    }
  ]
}

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