List participants

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/participants \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:9820/api/v1/siloc/participants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:9820/api/v1/siloc/participants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": true,
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ispb": "46026562",
      "name": "<string>",
      "role": "DIRECT",
      "status": "1",
      "updatedAt": "2023-11-07T05:31:56Z",
      "settlingInstitutionIspb": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

GET

api

siloc

participants

List participants

curl --request GET \
  --url http://localhost:9820/api/v1/siloc/participants \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:9820/api/v1/siloc/participants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:9820/api/v1/siloc/participants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": true,
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ispb": "46026562",
      "name": "<string>",
      "role": "DIRECT",
      "status": "1",
      "updatedAt": "2023-11-07T05:31:56Z",
      "settlingInstitutionIspb": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Query Parameters

role

enum<string>

Filter by participant role.

Available options:

DIRECT,

INDIRECT,

SETTLING_INSTITUTION

cursor

string

Opaque pagination cursor.

limit

integer<int64>

default:50

Page size (default 50, max 200).

Required range: 1 <= x <= 200

Response

hasMore

boolean

required

Whether more pages follow.

items

object[] | null

required

The page of participants (never null).

Show child attributes

nextCursor

string

Opaque cursor for the next page; empty when exhausted.

Integration

Connectivity

Participants

Cycles and settlement

Alerts and audit

Schedule

Error handling

List participants

Authorizations

Query Parameters

Response