Create case

Cases track an investigation on a payment. An outgoing case sends an investigation request to the counterparty over Swift and collects the responses it receives back. An internal case tracks an investigation on your side only, and exchanges no message.
A case is always about something, so at least one related object is required. An outgoing case also requires an investigation_request, whose eir is the reference every later message on the investigation echoes.
The investigation request is not sent during the call: the case is returned in processing, and the request leaves with the next file generated for the connected account. bank_data and investigation_request.message_id are filled in at that point.
This feature is only available to financial institution customers, and has to be enabled on your legal entity and on the connected account the case is opened on.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The body of POST /cases. Every optional field here and in the blocks it references is either omitted or carries a value: an empty string is rejected rather than stored.

string
enum
required

The type of the case. An outgoing case sends an investigation request to a counterparty and must carry an investigation_request. An internal case is only tracked on your side, and must not carry one. incoming cases are opened when a counterparty is sending an investigation request.

Allowed:
uuid
required

The ID of the connected account the case is opened on.

string
required
length ≤ 140

A short summary of the case.

string
required
length ≤ 500

The details of the case.

string
enum
required

The priority of the case.

Allowed:
string
enum

The business categorisation of the case. Required for an internal case, and not supported on an outgoing case: for type outgoing the category is inferred from investigation_type and investigation_sub_type.

investigation_request
object

The investigation to send to the counterparty. Required for an outgoing case, and rejected on an internal one.

metadata
object

Additional client data in JSON format. See Metadata.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json