Obtém a lista de operações de Renda Fixa Crédito mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

get https://api-smartkeys.celcoin.prd.fsapps.io/open-keys/data/api/v2/credit-fixed-incomes/v1/investments

Responses

Response body

object

data

array of objects

required

length ≥ 0

data*

object

brandName

string

required

length ≤ 80

Nome da Marca reportada pelo participante no Open Finance. Recomenda-se utilizar, sempre que possível, o mesmo nome de marca atribuído no campo do diretório Customer Friendly Server Name (Authorisation Server).

companyCnpj

string

required

length ≤ 14

Número completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara

investmentType

string

required

Especificação do ativo em questão (Debêntures, CRI ou CRA).

DEBENTURES CRI CRA

investmentId

string

required

length ≤ 100

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora.

links

object

required

Referências para outros recusos da API requisitada.

self

uri

required

length ≤ 2000

URI completo que gerou a resposta atual.

first

uri

length ≤ 2000

URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta

uri

length ≤ 2000

URI da página anterior dessa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta

uri

length ≤ 2000

URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta

last

uri

length ≤ 2000

URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta.

meta

object

required

Meta informações referente a API requisitada.

totalRecords

int32

required

Número total de registros no resultado

totalPages

int32

required

Número total de páginas no resultado

requestDateTime

date-time

required

length ≤ 20

Data e hora da consulta, conforme especificação RFC-3339, formato UTC.

Headers

object

Authorization

string

Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado

x-consent-id

string

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api-smartkeys.celcoin.prd.fsapps.io/open-keys/data/api/v2/credit-fixed-incomes/v1/investments?page=1&page-size=25' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/json; charset=utf-8

200Dados obtidos com sucesso.

defaultErro inesperado.