Previous page KYC Registry API Reference
Next pageNetwork Interoperability API
Retrieves entities in a paginated manner that matches the search criteria as given below.
| Scenarios for Offset and limit | Possible Outcomes |
|---|---|
| When no Offset or limit value is given | Then it will list 5 pages from record 1 onwards with default 10 records per page |
| When Offset value is 0 and limit 10 is given | It will list the first page with first 10 records |
| When Offset value is 10 and limit 10 is given | It will list the second page with next 10 records |
| When Offset value is 20 and limit 10 is given | It will list the last page with last 5 records |
| When Offset value is 0 and limit 5 is given | It will list the first page with first 5 records |
| When Offset value is 5 and limit 5 is given | It will list from record 5th onwards |
| When Offset value is 10 and limit 5 is given | It will list the second page with next 5 records |
| When Offset value other than 0,10,20 is given | Since it not a dynamic listing, it will still list the default listing of first 10 records |
Retrieves all entities that are under my group in a paginated manner. Set limit value as 5 with offset options as 0,5,10,15 and 20
| Scenarios for Offset and limit | Possible Outcomes |
|---|---|
| When no Offset or limit value is given | Then it will list 5 pages from record 1 onwards with default 5 records per page |
| When Offset value is 0 and limit 5 is given | It will list the first page with first 5 records |
| When Offset value is 5 and limit 5 is given | It will list the second page with next 5 records |
| When Offset value is 20 and limit 5 is given | It will list the last page with last 5 records |
| When Offset value other than 0,5,10,15 and 20 and limit 5 is given | Since it not a dynamic listing, it will still list the default listing of first 5 records |
| When limit other than 5 is given | It will still list the default listing of first 5 records |
Retrieves the list of counterparties in a paginated manner
| Scenarios for Offset and limit | Possible Outcomes |
|---|---|
| When no Offset value is given | Then it will list 5 pages from record 1 onwards with default 5 records per page |
| When Offset value is 0 and limit 5 is given | It will list the first page with first 5 records |
| When Offset value is 5 and limit 5 is given | It will list the second page with next 5 records |
| When Offset value is 25 and limit 5 is given | It will list the last page with last 5 records |
| When Offset value other than 0,5,10,15,20 and 25 and limit 5 is given | Since it not a dynamic listing, it will still list the default listing of first 5 records |
| Scenarios for Offset and limit | Possible Outcomes |
|---|---|
| When no Offset value is given | Then it will list all 3 pages from record 1 onwards with default 10 records per page |
| When Offset value is 0 and limit 10 is given | It will list the first page with first 10 records |
| When Offset value is 10 and limit 10 is given | It will list the second page with next 10 records |
| When Offset value is 20 and limit 10 is given | It will list the last page with last 10 records |
| When Offset value other than 0,5,10,15,20 and 25 and limit 10 is given | Since it not a dynamic listing, it will still list the default listing of first 5 records |
It retrieves data points and documentId of supporting documents of Counterparty in JSON file.
Sample FI entity's data for v4:
Sample Corporate entity's data for v4:
Corporate 1:
Sample FI entity's data:
Sample Corporate entity's data:
| Profile Retrieval scenarios (FI) | Output |
|---|---|
| When any of the above defined scenarios are executed | It will extract the entity KYC profile as a zip data folder with Json status as 200 |
| When last-published-since date is given as 2021-09-01 | It will return Json status as 204 |
| Different BIC/LEI/Tax ID/Reg No/last-published-since | It will throw json status as 400 |
For the last scenario, set the following:
Sample FI entity's data:
Sample Corporate entity's data: