Pave Bank
Sandbox/Simulate RFI/RFI Question

Create RFI Question

Add a new question to an existing Request for Information (RFI).

This endpoint is only available in our sandbox environment. It is not available in production.

Use this endpoint to add additional questions to an existing RFI in sandbox mode, simulating a scenario where Pave Bank requests further information after the initial RFI has been created.

Example Request

curl --request POST \
  --url https://developer-api-staging.pavebank.dev/v1/sandbox/rfis/<RFI_ID>/questions \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "question_type": "identification.individual.passport",
    "question_data": {
      "question_text": "Please provide a copy of your passport.",
      "comment": "You may include document(s) if needed.",
      "document_ids": ["<DOCUMENT_ID_1>", "<DOCUMENT_ID_2>"]
    }
  }'
POST
/v1/sandbox/rfis/{rfiID}/questions

Authorization

AuthorizationRequiredBearer <token>

Enter your token in the format: Bearer {token}

In: header

Request Body

application/jsonOptional
question_typeRequiredstring

The type of RFI question

Value in: "identification.individual.passport" | "identification.individual.national_id" | "identification.individual.proof_of_address" | "identification.individual.residence_permit" | "identification.individual.corrected_address" | "identification.legal_entity.business_registry" | "identification.legal_entity.ubo_documentation" | "identification.legal_entity.ubo_passports" | "identification.legal_entity.authorised_person_passport" | "kyc_kyb.confirm_kyc_details" | "kyc_kyb.confirm_kyb_details" | "kyc_kyb.onboarding_date_method" | "kyc_kyb.internal_risk_rating" | "business.individual.occupation" | "business.legal_entity.description" | "business.legal_entity.industry_classification" | "business.legal_entity.website_urls" | "transaction.purpose" | "transaction.supporting_document" | "transaction.counterparty_info" | "sof.document" | "sof.explanation" | "sow.document" | "sow.explanation" | "pattern.expected_monthly_turnover" | "pattern.expected_volume_frequency" | "pattern.explain_unusual_activity.spike_in_activity" | "pattern.explain_unusual_activity.drop_in_activity" | "pattern.explain_unusual_activity.unexpected_counterparty" | "pattern.explain_unusual_activity.unexpected_jurisdiction" | "pattern.explain_unusual_activity.volume_exceeds_expected" | "pattern.explain_unusual_activity.dormant_now_active" | "pattern.explain_unusual_activity.pattern_unusual" | "pattern.explain_unusual_activity.other" | "other.additional_explanation" | "other.supporting_evidence"
question_dataobject

Data associated with an RFI question

Path Parameters

rfiIDRequiredstring

The unique identifier of the RFI

Response Body

idRequiredstring

The unique identifier of the RFI question

curl -X POST "https://developer-api-staging.pavebank.dev/v1/sandbox/rfis/string/questions" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "question_type": "identification.individual.passport",
    "question_data": {
      "question_text": "What is the purpose of this transaction?",
      "comment": "string",
      "document_ids": [
        "string"
      ]
    }
  }'
{
  "id": "string"
}