Skip to main content

API is used to lookup the participants using entity identifier, type, status and attributes.

API is used to lookup the participants using entity identifier, type, status and attributes.

Path Parameters
type string REQUIRED

Possible values: [LOAN_AGENT, LENDER, DERIVED_DATA_PROVIDER, COLLECTIONS_PARTNER, KYC_PARTNER, DISBURSEMENT_PARTNER]

Type of the entity e.g. Borrower Agent(BA), Lender, Data Provider

Example: LOAN_AGENT
Header Parameters
Signature byte REQUIRED

Detached JWS of the body. This is the digital signature of the request body signed using the signing private key of the caller. For bodyless request JWS of path should be provided,
e.g. for API GET /v1/{type}/{id}, JWS of /{type}/{id}

Request Body
name string
version string
baseUrl string
size integer

maximum number of elements in a page.

page integer

page number, default is 0

id uuid

id of the entity

status string

Possible values: [ACTIVE, BLOCKED, INACTIVE]

Responses
200

Array of participant details that meet the search criteria.

Schema OPTIONAL
content OPTIONAL
number integer OPTIONAL

index of page

size integer OPTIONAL
totalElements integer OPTIONAL

total number of elementes found for given query

totalPages integer OPTIONAL
last boolean OPTIONAL

true if this is last page

numberOfElements integer OPTIONAL
first boolean OPTIONAL

true if this is first page

400

Invalid request

404

Not found