GuidesAPI ReferenceChangelog
API Reference

Get a recipient RFI case

Retrieve a recipient RFI case with its current requirements and evidence.

Retrieve the case before deciding whether you need to respond. The response shows the overall case status and each requirement with its current evidence. The API does not return previous evidence as submission history.

This is the shared RFI endpoint. The full response schema and Try It console are on Get an RFI case.

GET /v1/customers/{customer_id}/rfi-cases/{case_id}

You get the case_id from three places: resource.id of an rfi.recipient.* webhook, action_required.case_id on the recipient, or the case_id of an item returned by List recipient RFI cases.

Response

{
  "case_id": "TC-3N7Q-D2KV",
  "case_class": "RECIPIENT",
  "rfi_status": "ACTION_REQUIRED",
  "subject": {
    "type": "RECIPIENT",
    "id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "requirements": [
    {
      "requirement_id": "RQ-5K2P-M8WD",
      "type": "TEXT",
      "accepted_document_types": [],
      "required": true,
      "status": "ACTION_REQUIRED",
      "note": "Please describe your business relationship with this recipient.",
      "submissions": []
    },
    {
      "requirement_id": "RQ-9F4C-T2LN",
      "type": "FILE",
      "accepted_document_types": [
        "STANDARD_RECIPIENT_INFORMATION"
      ],
      "required": true,
      "status": "ANSWERED",
      "note": "Please provide the signed agreement with this recipient.",
      "submissions": [
        {
          "submission_id": "RS-7Q2M-K4XD",
          "type": "FILE",
          "document_type": "STANDARD_RECIPIENT_INFORMATION",
          "text": null,
          "note": "Services agreement and the invoices for the planned payments.",
          "file_name": "acme-msa-signed.pdf",
          "submitted_by": "CUSTOMER",
          "submitted_at": "2026-09-23T09:02:17.540+00:00"
        }
      ]
    }
  ],
  "created_at": "2026-09-23T08:15:42.118+00:00",
  "updated_at": "2026-09-23T09:02:17.540+00:00"
}

Fields

FieldDescription
case_idThe RFI case ID. Use it in webhooks, list filters, and the submissions endpoint.
case_classRECIPIENT for a recipient case; mirrors subject.type.
rfi_statusOverall case status: ACTION_REQUIRED, PENDING_REVIEW, ANSWERED, REJECTED, or CLOSED. See Recipient RFI Overview.
subject.typeRECIPIENT.
subject.idThe recipient_id. A recipient subject has no transaction_type.
requirements[].requirement_idStable ID for correlation only. Do not send it when responding; we match your response to the requirement.
requirements[].typeTEXT or FILE.
requirements[].accepted_document_typesFor a FILE requirement, the document_type values that complete it; any one is enough. Empty for TEXT.
requirements[].requiredWhether the requirement must be answered.
requirements[].statusACTION_REQUIRED when it needs a new or corrected response, ANSWERED when we hold the current response.
requirements[].noteThe latest instruction from compliance for this requirement.
requirements[].submissions[]The current evidence for the requirement: submission_id, type, document_type and file_name for FILE, text for TEXT, note, submitted_by (CUSTOMER or COMPLIANCE), submitted_at.
created_at, updated_atISO 8601 UTC timestamps. updated_at drives the updated_from list filter.

The case status never tells you whether the recipient can be paid. Read the recipient's status, or wait for recipient.approved or recipient.rejected.