Get the details of a relationship
1 min
GET
https://provisioning.rs.int.{environment}.korfinancial.com/relationships/{relationshipIdentifier}
Path Parameters
- relationshipIdentifierstring<uuid>requiredExampleDescription
Query Parameters
- entityIdstring<uuid>ExampleDescription
Responses
200
- RelationshipDetailDescription
- identifierstring<uuid>Example
- lastModifiedTimestampstring<date-time>ExampleDescription
- createdTimestampstring<date-time>ExampleDescription
- warningsWarning[]Description
- fieldNamestringDescription
- descriptionstringDescription
- reasonstringDescription
- categoryDescription
- tagstringDescription
- argumentNamestringDescription
- argumentValuestringDescription
- failureReasonstring
- clientPayloadstring
- clientPayloadContentTypeIngestionContentTypeDescription
- supplementalDataSupplementalDataDescription
- statusstringDescription
- warningCountnumberExampleDescription
- kdmRuleReferencesKdmRuleReference[]Description
- identifierstring<uuid>ExampleDescription
- kdmFieldNamestringExampleDescription
- versionstringExampleDescription
- relationshipKdmRelationshipKdmDescription
- statusstringrequiredDescription
- interAffiliatebooleanDescription
- myEntityInternalIdentifierstringrequiredExampleDescription
- otherEntityInternalIdentifierstringrequiredExampleDescription
- UTICreatorobject[]
- effectiveDatestring<date>Example
- valuemap<string, string>
- myEntityCFTCPrivacyLawIdentifierstringDescription
- CFTCReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- SECSBRReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- EMIREUMyReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- EMIREUOtherReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- EMIRUKMyReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- EMIRUKOtherReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- CAReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- ASICMyReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- ASICOtherReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- MASMyReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- MASOtherReportingEntityobject[]
- effectiveDatestring<date>Example
- valueReportingEntityDescription
- otherEntityCFTCPrivacyLawIdentifierstringDescription
- masterAgreementTypeobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string>
- otherMasterAgreementTypeobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string>
- masterAgreementVersionobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string>
- collateralisationCategoryobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string>
- EMIRUKMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIRUKOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIRUKMyEntityTransactionListedDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIRUKOtherEntityTransactionListedDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- SECSBRMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- SECSBROtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CAMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CAOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- SECSBRMyEntityPublicDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- SECSBROtherEntityPublicDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CAMyEntityPublicDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CAOtherEntityPublicDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CFTCMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CFTCOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CFTCMyEntityPublicDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- CFTCOtherEntityPublicDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIREUMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- ASICOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIREUMyEntityTransactionListedDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIREUOtherEntityTransactionListedDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- ACERREMITMyEntityDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- ACERREMITOtherEntityDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- ASICMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- EMIREUOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- MASMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- MASOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- HKMAMyEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- HKMAOtherEntityTransactionDroitFulfilledObligationsobject[]Description
- effectiveDatestring<date>Example
- valuemap<string, string[]>
- droitPartyRolestringExampleDescription
- permissionsPermissionsDescription
- canEditbooleanExampleDescription
- canDeletebooleanExampleDescription
400
401
403
404
405
406
415
500
504
default
curl
curl --request GET \
--url https://provisioning.rs.int.{environment}.korfinancial.com/relationships/{relationshipIdentifier} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://provisioning.rs.int.{environment}.korfinancial.com/relationships/{relationshipIdentifier}", 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/relationships/{relationshipIdentifier}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://provisioning.rs.int.{environment}.korfinancial.com/relationships/{relationshipIdentifier}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Relationship retrieved
{
"identifier": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB",
"lastModifiedTimestamp": "2020-05-28T14:07:17Z",
"createdTimestamp": "2020-05-28T14:07:17Z",
"warnings": [
{
"fieldName": "",
"description": "",
"reason": "",
"category": "",
"tag": "",
"argumentName": "",
"argumentValue": ""
}
],
"failureReason": "",
"clientPayload": "",
"clientPayloadContentType": "",
"supplementalData": [
""
],
"status": "",
"warningCount": 2,
"kdmRuleReferences": [
{
"identifier": "542A4166-24ED-4496-9FFC-B64BD2B207A1",
"kdmFieldName": "myEntityIdentifier",
"version": 1
}
],
"relationshipKdm": {
"status": "",
"interAffiliate": false,
"myEntityInternalIdentifier": "27ID",
"otherEntityInternalIdentifier": "27ID",
"UTICreator": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"myEntityCFTCPrivacyLawIdentifier": "",
"CFTCReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"SECSBRReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIREUMyReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIREUOtherReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIRUKMyReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIRUKOtherReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CAReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"ASICMyReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"ASICOtherReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"MASMyReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"MASOtherReportingEntity": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"otherEntityCFTCPrivacyLawIdentifier": "",
"masterAgreementType": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"otherMasterAgreementType": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"masterAgreementVersion": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"collateralisationCategory": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIRUKMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIRUKOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIRUKMyEntityTransactionListedDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIRUKOtherEntityTransactionListedDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"SECSBRMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"SECSBROtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CAMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CAOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"SECSBRMyEntityPublicDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"SECSBROtherEntityPublicDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CAMyEntityPublicDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CAOtherEntityPublicDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CFTCMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CFTCOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CFTCMyEntityPublicDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"CFTCOtherEntityPublicDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIREUMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"ASICOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIREUMyEntityTransactionListedDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIREUOtherEntityTransactionListedDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"ACERREMITMyEntityDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"ACERREMITOtherEntityDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"ASICMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"EMIREUOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"MASMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"MASOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"HKMAMyEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"HKMAOtherEntityTransactionDroitFulfilledObligations": [
{
"effectiveDate": "2020-01-01",
"value": ""
}
],
"droitPartyRole": "Both"
},
"permissions": {
"canEdit": true,
"canDelete": true
}
}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