Respond to case

Answer an investigation that is waiting on you. Only an incoming or an internal case can be responded to, and only while it is in pending_action: on an outgoing case the answer is the counterparty's to give.
On an incoming case the answer is sent to the requester over Swift, in the same step that records it. CLSD resolves the investigation and moves the case to resolved, and RJCT declines it and moves the case to rejected. PDNG is an interim answer telling the requester you are working on it: the case stays in pending_action, the answer is not added to investigation_responses, and it is announced with a case.pending event.
An internal case has no counterparty, so its answer is recorded and nothing is sent. It only takes CLSD, which moves the case to resolved.
A CLSD or RJCT answer is appended to investigation_responses.
An internal case carries no investigation, so the rules below do not apply to it. On an incoming case, a sequence always echoes one of the investigation request's entries, when it has any, and a CLSD answering a UTAP or RQFI investigation, whatever its sub-type, needs at least one entry, each carrying transaction_data or a response_narrative. Beyond that, what data has to carry depends on the investigation being answered, whatever the status code:

  • CCNR or CONR: at most one entry, with no sequence and no transaction_data. The entry carries a confirmation whose debit_credit_indicator is CRDT, and a CLSD needs it.
  • UTAP: no sequence and no confirmation. Every entry carries transaction_data or a response_narrative, and a record may only carry unstructured_remittance.
  • RQFI with a sub-type of UTEX: a sequence on every entry, each answering a different request entry, and no confirmation. Every entry carries transaction_data or a response_narrative, and a record may only carry code, date and other.
  • RQFI with a sub-type of SANC, FWTR, AMLI, FRAD or FCCI: a sequence on every entry, each answering a different request entry, and no confirmation. Every entry carries transaction_data or a response_narrative, and a record may carry any field.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The ID of the case.

Body Params

The body of POST /cases/{id}/respond. 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 ISO 20022 status code of the answer. An internal case only takes CLSD.

  • CLSD: the investigation is resolved, and the case moves to resolved.
  • RJCT: the investigation is declined, and the case moves to rejected.
  • PDNG: an interim answer, telling the requester the investigation is being worked on. The case stays in pending_action.
Allowed:
string
length between 4 and 4

The ISO 20022 reason code qualifying status_code. Checked for length only, like the reason_code of an investigation request entry.

data
array of objects
length ≤ 100

The details of the answer. Which entries are required, and what each one may carry, depends on the investigation being answered: see POST /cases/{id}/respond.

data
Responses

404

The specified resource was not found.

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