List Open Finance Participants

GET 
/open-finance/participants

Retrieve a list of all Open Finance participants.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [id, friendlyName, createdAt]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

The product ID is a UUID (v4) used to identify the Z.ro product configuration.

x-product-target-user-uuid string

The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses

200

The participants returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Open Finance participants data.
Array [
id stringrequired
Open Finance participant id.
friendly_name stringrequired
Open Finance participant friendly name.
friendly_logo_uri string
Open Finance participant friendly logo URI.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "friendly_name": "Open Finance Participant",
      "friendly_logo_uri": "https://example.com/logo.png"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Loading...