Last updated 10 months ago
Was this helpful?
Perform various operations on wire Office of Foreign Assets Control (OFAC) records.
Symitar eDocs References: Coming soon.
Retrieve Office of Foreign Assets Control (OFAC) details
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"AdministrativeCredentials":{"Password":"suwn37834b91&"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/wire/getWireOfacDetails HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 174 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "WireOfacDetailsLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "WireOfacDetails": { "Locator": 1, "Text": [ { "EntryId": 1, "Text": "text" } ] } }
Retrieve Office of Foreign Assets Control (OFAC) details with selected fields
POST /nexum/627/2022.01/wire/getWireOfacDetailsSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 286 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "WireOfacDetailsLocator": 1, "SelectableFields": { "IncludeAllWireOfacDetailsFields": true, "WireOfacDetailsFields": { "Locator": true, "Text": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve paged Office of Foreign Assets Control (OFAC) details
POST /nexum/627/2022.01/wire/getWireOfacDetailsPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 241 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WireOfacDetails": [ { "Locator": 1, "Text": [ { "EntryId": 1, "Text": "text" } ] } ], "Token": "text" }
Retrieve a list of Office of Foreign Assets Control (OFAC) details with selected fields
POST /nexum/627/2022.01/wire/getWireOfacDetailsListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 259 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "SelectableFields": { "IncludeAllWireOfacDetailsFields": true, "WireOfacDetailsFields": { "Locator": true, "Text": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "WireOfacDetailsList": { "hasReachedMaximumListSize": true, "WireOfacDetails": [ { "Locator": 1, "Text": [ { "EntryId": 1, "Text": "text" } ] } ] } }
Searches for wire OFAC details with selected fields
POST /nexum/627/2022.01/wire/searchWireOfacDetailsSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 291 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "SelectableFields": { "IncludeAllWireOfacDetailsFields": true, "WireOfacDetailsFields": { "Locator": true, "Text": [ 1 ] } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Retrieve paged Office of Foreign Assets Control (OFAC) details with selected fields
POST /nexum/627/2022.01/wire/getWireOfacDetailsPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 353 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWireOfacDetailsFields": true, "WireOfacDetailsFields": { "Locator": true, "Text": [ 1 ] } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Searches for wire OFAC details paged with selected fields
POST /nexum/627/2022.01/wire/searchWireOfacDetailsPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 368 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireSequenceNumber": 1, "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllWireOfacDetailsFields": true, "WireOfacDetailsFields": { "Locator": true, "Text": [ 1 ] } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
Updates OFAC details for a wire by ID
POST /nexum/627/2022.01/wire/updateWireOfacDetailsByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 246 { "Credentials": { "AdministrativeCredentials": { "Password": "suwn37834b91&" } }, "WireOfacDetailsLocator": 1, "WireOfacDetailsUpdatableFields": { "Text": [ { "EntryId": 1, "Text": "text" } ] }, "WireSequenceNumber": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }