Retrieve a List of Required Documents

The GET /DocumentUploadRequirement endpoint returns a structured list of documents required for a specific banking process or transaction. The response is organized by document category — such as business profile, IDs, taxes, insurance, and more — so the caller knows exactly what to collect before initiating an upload. This helps minimize errors and delays during account verification, loan applications, or other compliance-driven workflows.

Endpoint

GET /DocumentUploadRequirement

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Call this endpoint before presenting the document upload flow to a customer. It tells your application which document categories are pending, what specific document types are required within each category, and what the current verification status is for each. Use the response to drive conditional UI logic — for example, showing only the sections that still require uploads.

Response

200 OK

The response is a documentUploadRequirementViewModel object. Each top-level field represents a document category and is structured as a currentVerification object.

Top-level category fields:

currentVerification object fields:

result object fields:

requiredDocument object fields:

documentUploadSession object fields:

{
  "businessProfile": {
    "section": "BusinessProfile",
    "results": [
      {
        "code": "DOCUMENT_REQUIRED",
        "description": "Business formation documents are required for verification."
      }
    ],
    "requiredDocuments": [
      {
        "createdAt": "2025-11-01T10:00:00Z",
        "updatedAt": "2025-11-15T08:30:00Z",
        "status": "PENDING",
        "condition": "Business entity must provide articles of incorporation.",
        "documentUploadSession": {
          "type": 0,
          "id": "sess_abc123def456",
          "primaryDocumentTypes": ["ARTICLES_OF_INCORPORATION", "BUSINESS_LICENSE"]
        }
      }
    ]
  },
  "primaryAuthorizedPerson": {
    "section": "PrimaryAuthorizedPerson",
    "results": [],
    "requiredDocuments": []
  },
  "ultimateBeneficialOwners": {
    "section": "UltimateBeneficialOwners",
    "results": [],
    "requiredDocuments": [
      {
        "createdAt": "2025-11-01T10:00:00Z",
        "updatedAt": "2025-11-15T08:30:00Z",
        "status": "PENDING",
        "condition": "Owner with 25% or more ownership must provide identity verification.",
        "documentUploadSession": {
          "type": 0,
          "id": "sess_xyz789ghi012",
          "primaryDocumentTypes": ["GOVERNMENT_ID", "PASSPORT"]
        }
      }
    ]
  },
  "currentVerification": null,
  "other": null,
  "insurance": null,
  "military": null,
  "iDs": {
    "section": "IDs",
    "results": [],
    "requiredDocuments": [
      {
        "createdAt": "2025-11-01T10:00:00Z",
        "updatedAt": "2025-11-15T08:30:00Z",
        "status": "PENDING",
        "condition": "Valid government-issued photo ID required.",
        "documentUploadSession": {
          "type": 0,
          "id": "sess_id001jkl345",
          "primaryDocumentTypes": ["DRIVERS_LICENSE", "STATE_ID", "PASSPORT"]
        }
      }
    ]
  },
  "taxes": null,
  "bills": null,
  "statements": null
}

Error Codes

Common Mistakes

• Assuming a null category means no action is needed — a null value means no requirements exist for that category at this time, but requirements may appear after subsequent verification steps are triggered.
• Ignoring the status field on each requiredDocument — a document with status SUBMITTED or APPROVED does not need to be re-uploaded; only PENDING documents require action.
• Not using the documentUploadSession.id when submitting documents — the session ID links the uploaded file to the correct verification requirement.
• Calling this endpoint without first authenticating the correct partner and customer context, which can return an empty or mismatched requirement set.

Related Endpoints

• POST /DocumentUpload — Submit a document file against a specific upload session
• GET /DocumentUpload/{documentId} — Retrieve the status and details of a previously uploaded document
• POST /api/auth/v2 — Obtain a Bearer token for authentication

Example

curl -X GET https://api.banking.netevia.dev/DocumentUploadRequirement \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"