Documentación de Consolidated Financial Connections

ConsolidatedFinancialConnectionsApi v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

• https://$(catalog.host)/modules

Email: Iberinform Web: Iberinform

Authentication

• API Key (ClientSecretHeader)

  • Parameter Name: X-IBM-Client-Secret, in: header. Secret Key

• API Key (APIKeyHeader)

  • Parameter Name: X-IBM-Client-Id, in: header. pmartinm

Default

get__consolidatedFinancialConnections_{organisationID}

Code samples

require 'rest-client'

require 'json'


headers = {

 'Accept' => 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY'

}


result = RestClient.get 'https://$(catalog.host)/modules/consolidatedFinancialConnections/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)

import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/modules/consolidatedFinancialConnections/{organisationID}', headers = headers)


print(r.json())

GET https://$(catalog.host)/modules/consolidatedFinancialConnections/{organisationID} HTTP/1.1


Accept: application/json

const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/modules/consolidatedFinancialConnections/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});

GET /consolidatedFinancialConnections/{organisationID}

Parameters

Name	In	Type	Required	Description
organisationID	path	string	true	identificador de la firma
language	query	string	false	Idioma generación

Example responses

200 Response

"{"investeeCompanies":{"dataSource":{"date":"string","source":"string"},"elements":[{"directHolding":"string","holdingPercentage":"string","indirectHolding":"string","legalForm":{"code":"string","value":"string"},"name":"string","nonPaymentRating":"string","taxId":"string","type":{"code":"string","value":"string"}}],"unavailabilityReason":"string"},"notAvailable":"string","shareholders":{"dataSource":{"date":"string","source":"string"},"elements":[{"country":"string","legalForm":{"code":"string","value":"string"},"name":"string","nonPaymentRating":"string","percentage":"string","taxId":"string"}],"unavailabilityReason":"string"}}"

Responses

Status	Meaning	Description	Schema
200	OK	200 OK	consolidatedFinancialConnectionDetail
401	Unauthorized	Unauthorized	ErrorDetail
403	Forbidden	Forbidden	ErrorDetail
404	Not Found	Recurso no encontrado	ErrorDetail
500	Internal Server Error	Internal error	ErrorDetail

Schemas

ErrorDetail

{

 "code": "string",

 "message": "string",

 "principal": "string",

 "status": 0

}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
message	string	false	none	none
principal	string	false	none	none
status	integer(int32)	false	none	none

consolidatedFinancialConnectionDetail

"{"investeeCompanies":{"dataSource":{"date":"string","source":"string"},"elements":[{"directHolding":"string","holdingPercentage":"string","indirectHolding":"string","legalForm":{"code":"string","value":"string"},"name":"string","nonPaymentRating":"string","taxId":"string","type":{"code":"string","value":"string"}}],"unavailabilityReason":"string"},"notAvailable":"string","shareholders":{"dataSource":{"date":"string","source":"string"},"elements":[{"country":"string","legalForm":{"code":"string","value":"string"},"name":"string","nonPaymentRating":"string","percentage":"string","taxId":"string"}],"unavailabilityReason":"string"}}"

Properties

Name	Type	Required	Restrictions	Description
investeeCompanies	object	false	none	none
dataSource	object	false	none	none
date	string	false	none	none
source	string	false	none	none
elements	[object]	false	none	none
directHolding	string	false	none	none
holdingPercentage	string	false	none	none
indirectHolding	string	false	none	none
legalForm	object	false	none	none
code	string	false	none	none
value	string	false	none	none
name	string	false	none	none
nonPaymentRating	string	false	none	none
taxId	string	false	none	none
type	object	false	none	none
code	string	false	none	none
value	string	false	none	none
unavailabilityReason	string	false	none	none
notAvailable	string	false	none	none
shareholders	object	false	none	none
dataSource	object	false	none	none
date	string	false	none	none
source	string	false	none	none
elements	[object]	false	none	none
country	string	false	none	none
legalForm	object	false	none	none
code	string	false	none	none
value	string	false	none	none
name	string	false	none	none
nonPaymentRating	string	false	none	none
percentage	string	false	none	none
taxId	string	false	none	none
unavailabilityReason	string	false	none	none