User - Proof of Address (POA)
Address Document Module | SDK & API
Overview
The Address Document Module enables structured and reliable Proof of Address (POA) verification as part of KYC. It replaces the legacy User Document Module – POA and provides stronger validation, configurable document rules, and support for multiple file types.
This module is recommended for all new integrations.
Module Availability & Defaults
- New customers: Address Document Module is enabled by default
- Existing customers: Enabled if using the Address Verification Template.
Supported Documents
Customers can configure which POA document types are allowed, such as:
- National ID (front / back)
- Utility or service bills
- Financial statements
- Government correspondence
- Residential or rental documents
- Employment or education documents
- Legal documents
- Other address documents
Document availability and validation rules are managed via the dashboard within Templates.
File Upload Rules
| Rule | Value |
|---|---|
| Maximum documents per check | Up to 2 |
| File formats | PDF and/or Images |
| Image formats | JPG, JPEG, PNG |
| File size limit | 10 MB per file |
SDK Behaviour (Onboarding Flow)
When using the onboarding SDK:
- Users must select a document type before upload
- Upload rules are dynamically applied based on the selected document
- On-device quality checks detect:
- Blurry or unreadable documents
- Unsupported file formats
- If the uploaded document does not match the selected document type, an error is shown
- Users see clear guidance on allowed file types and remaining upload count
Note: On-device checks and document-type mismatch validation apply only to SDK-based integrations, not API-only flows.
API Integration
Endpoint
POST /api/v1/verify/run_user_verification
Address Document Payload
When submitting POA via API, include the file_sub_type parameter to specify the document type.
{
"additional_info": [
{
"additional_info_type": "ADDRESS_PROOF_DOCUMENT",
"additional_info_data": [
{
"file": "base64_payload_string",
"file_sub_type": "NATIONAL_ID_FRONT"
}
]
}
]
}
Only the payload portion of the base64 string should be sent.
Validation & Enforcement
Validation rules are enforced at both:
- SDK level (on-device checks)
- Backend level (API validation)
This includes:
- File type and size limits
- Document count limits
- Customer-configured document rules
- Module exclusivity checks
RecommendationWe strongly recommend switching to the Address Document Module in place of the legacy User Document Module to benefit from: Better document classification, Stronger validation, Improved user experience & Future enhancements
The module has already been enabled on your template. Please reach out if you need assistance with migration or configuration.
Updated 10 days ago
