Skip to main content

OpenRfiRequest

subjectTypestringrequired

The subject the RFI is raised against.

Possible values: [ONBOARDING_APPLICATION, TRANSACTION, MULTI_TRANSACTION]

subjectIdstring<uuid>required

UUID of the subject. For ONBOARDING_APPLICATION this is the same value as the AccountId header; for TRANSACTION it is the transaction id.

subjectReferencestring

Human-readable subject reference. Required when subjectType=TRANSACTION.

customerDisplayMessagestring

Customer-facing message explaining what the RFI is about.

questions object[]

Questions the customer must answer. At least one question or one document request must be provided.

  • Array [
    • promptstringrequired

    The question prompt shown to the customer.

    Possible values: non-empty

  • ]
    • documentRequests object[]

    Document requests the customer must fulfil. At least one question or one document request must be provided.

  • Array [
    • customLabelstringrequired

    Free-text description of the document the customer is being asked to provide (e.g. "Latest bank statement covering the last 3 months"). Shown to the customer alongside the request.

    Possible values: non-empty

    perItemDisplayMessagestring

    Optional per-item message explaining why this document is required.

  • ]
    • OpenRfiRequest
    {
      "subjectType": "ONBOARDING_APPLICATION",
      "subjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subjectReference": "string",
      "customerDisplayMessage": "string",
      "questions": [
        {
          "prompt": "string"
        }
      ],
      "documentRequests": [
        {
          "customLabel": "string",
          "perItemDisplayMessage": "string"
        }
      ]
    }