Get Registration Documents

Retrieves the registration documents required for a merchant's registration.

Overview

The Get Registration Documents endpoint helps you retrieve the registration documents required for a merchant's registration process. This endpoint provides essential information for managing document requirements, verification status, and compliance workflows.

file-alt
View Required Documents

Identify which documents the merchant needs to provide and display a comprehensive list of required documents within your application.

Key Benefits:

  • Clear visibility into document requirements
  • Streamlined merchant onboarding
  • Reduced back-and-forth communication
check-circle
Auto-Verification Results

Understand which verifications passed or failed, and provide targeted feedback to merchants when additional information is needed.

Key Benefits:

  • Real-time verification status
  • Automated compliance checking
  • Improved merchant experience
upload
Document Upload Facilitation

Build intuitive document upload pages within your application using the information from this endpoint to guide merchants through the submission process.

Key Benefits:

  • Guided document submission
  • Reduced abandonment rates
  • Better user experience
cog
Administrative Management

Manage document requirements and statuses from an administrative perspective while ensuring compliance with underwriting and regulatory requirements.

Key Benefits:

  • Centralized document management
  • Compliance oversight
  • Operational efficiency

Implementation Workflow

flow-chartDocument Requirements Flow
  1. Fetch Requirements: Call the endpoint to get current document requirements
  2. Display to Merchant: Present the list in a user-friendly format
  3. Track Progress: Monitor which documents have been submitted
  4. Handle Updates: Refresh requirements as merchant progresses through registration
shield-checkVerification Management
  1. Check Status: Retrieve auto-verification results for submitted documents
  2. Provide Feedback: Inform merchants of verification outcomes
  3. Handle Rejections: Guide merchants through resubmission process
  4. Maintain Records: Keep audit trail of verification attempts
Path Params
string
required
Query Params
string

Filters registration documents by the user id of the user who manually created this registration document.

string
enum

Filters registration documents by the given subject.

Allowed:
string
enum

Filters registration documents by the given type.

boolean
Defaults to true

Filters registration documents by whether or not they are enabled

boolean
Defaults to false

Whether or not to calculate and fill the response with all registration documents for this registration record regardless of if they exist or not.

string
enum

Groups registration documents by the given property.

Allowed:
Responses

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