Swift API Sandbox Collections API Documentation
Invalid Pattern: 'group_id'
GET {{baseUrl}}/institution-review?institution_rating_set=AML-I&country_rating_set=AML-C&target_currency=USD&reporting_period=2019-05-12&group_id=WRONG_PATTERN&exposure=DIRE_direct&direction=SENT_sent
Get Institution Review data for a specified time period, institution and country rating set, currency and other filter criterias
Body
PARAM
| Key | Datatype | Required | Description |
institution_rating_set
|
string | (Required) Identification of the rating set used to qualify the risks linked to institutions. | |
country_rating_set
|
string | (Required) Identification of the rating set used to qualify the risks linked to countries. | |
target_currency
|
string | (Required) Currency into which an amount is to be converted in a currency conversion. Valid currency codes are registered with the ISO 4217 Maintenance Agency, and consist of three contiguous letters. | |
reporting_period
|
string | (Required) specifies the day the reported data covers in format YYYY-MM-DD (ISO 8601 & RFC3339 section 5.6). | |
group_id
|
string | Identifies the group to which the institution belongs. Either id or group_id may be used, but not both. | |
exposure
|
string | (Required) > Specifies the selected institution’s presence in the payment flow. * `DIRE_direct` - The selected insitution is the sender or the receiver of the messages. * `DIIN_direct_and_indirect` - The selected institution is present anywhere in the payment flow | |
direction
|
string | (Required) > Filters messages on whether they were sent (outbound) or received (outbound). * `RECE_received` - Only received (inbound) messages are considered. * `SENT_sent` - Only sent (outbound) messages are considered. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status
Curl
curl -X GET 'https://sandbox.swift.com/bi/compliance-analytics/v1/institution-review?institution_rating_set=AML-I&country_rating_set=AML-C&target_currency=USD&reporting_period=2019-05-12&group_id=WRONG_PATTERN&exposure=DIRE_direct&direction=SENT_sent?institution_rating_set=AML-I&country_rating_set=AML-C&target_currency=USD&reporting_period=2019-05-12&group_id=WRONG_PATTERN&exposure=DIRE_direct&direction=SENT_sent'
ENDPOINTS