Configuration Parameters
The Proof of Address (PoA) verification service validates user-submitted address documents, such as utility bills, bank statements, and government letters, through OCR extraction, structured address parsing, and optional address authenticity verification.
The following parameters allow you to customize the verification behavior according to your compliance and business requirements.
Parameter Overview
| Parameter | Type | Required | Default |
|---|---|---|---|
addressSplitVerify | Enum (SPLIT_AND_VERIFY | SPLIT_ONLY) | Optional | SPLIT_AND_VERIFY |
allowIdDocumentAsPoa | Boolean | Optional | false |
issueDayWindowMonths | Integer (3 | 4 | 5 | 6) | Optional | 3 |
Parameter Details
addressSplitVerify
addressSplitVerifyType: Enum (SPLIT_AND_VERIFY | SPLIT_ONLY)
Determines how the system processes the address after OCR extraction from the submitted document.
SPLIT_AND_VERIFY
SPLIT_AND_VERIFY- Splits the extracted address into structured components
- Verifies whether the address physically exists
- Returns
validAddress = trueupon successful verification - Includes enhanced parsing capabilities for non-standard address formats, such as:
- missing postal codes
- informal building names
This mode is designed to maximize verification pass rates while ensuring address authenticity.
SPLIT_ONLY
SPLIT_ONLY- Splits the extracted address into structured components
- Standardizes the extracted address
- Does not perform address authenticity verification
- Does not return
validAddress
This mode provides faster response times and is suitable when standardized address output is sufficient.
allowIdDocumentAsPoa
allowIdDocumentAsPoaType: Boolean
Controls whether identity documents — specifically Passport, ID Card, and Driving License — are accepted as valid proof of address material.
When enabled:
- Identity documents are accepted as valid PoA submissions
- The system automatically identifies the document type
- If the uploaded file is recognized as an identity document, it is accepted
- The
issueDayWindowMonthsvalidity check is skipped for identity documents, since they typically have longer validity periods
When disabled:
- Identity documents are not accepted as proof of address
- If the uploaded file is identified as an identity document, the system immediately returns an error and ends the verification process
issueDayWindowMonths
issueDayWindowMonthsType: Integer (3 | 4 | 5 | 6)
Defines the maximum age, in months, of the document issue date for the document to remain valid.
The system adds the configured number of months to the issue date printed on the document to calculate an expiry date. If the current date exceeds the calculated expiry date, the document is rejected with a DOCUMENT_EXPIRED error.
For example:
3means only documents issued within the last 3 months are accepted
Note: This check is skipped for identity documents when
allowIdDocumentAsPoais enabled.
addressSplitVerify — Enum Values
addressSplitVerify — Enum Values| Value | Behavior |
|---|---|
SPLIT_AND_VERIFY | Performs address splitting and authenticity verification. Splits the extracted address into structured components and verifies whether the address physically exists. Returns validAddress. Includes enhanced parsing for non-standard address formats. |
SPLIT_ONLY | Performs address splitting only. Splits the extracted address into structured components and standardizes it. Does not perform authenticity verification and does not return validAddress. Provides faster response times. |
documentFormatAllowance — Sub-configuration Group
documentFormatAllowance — Sub-configuration GroupdocumentFormatAllowance is a group of boolean switches that controls which non-standard document formats are accepted for upload.
Each format can be enabled or disabled individually. When a format is explicitly enabled, the corresponding format validation rule is relaxed for that verification. If not configured, the default document format validation rules apply.
| Field | Type | Default | Description |
|---|---|---|---|
allowPhotocopy | Boolean | false | Accepts photocopied documents. If not enabled, photocopies are rejected by default. |
allowColorCopy | Boolean | false | Accepts color-copied documents. |
allowBlackAndWhite | Boolean | false | Accepts black-and-white printed documents. If not enabled, black-and-white images are rejected and the user is prompted to upload a full-color image. |
allowScreenshot | Boolean | false | Accepts screenshots of documents. If not enabled, screenshots are rejected and the user is prompted to upload a clear photo or the original file. |
allowScanned | Boolean | false | Accepts scanned copies of documents. If not enabled, scanned copies are rejected and the user is prompted to upload the original document. |
Behavior Notes
Identity Documents & Issue Date
When allowIdDocumentAsPoa is enabled, the system automatically identifies whether the uploaded file is an identity document, including:
- Passport
- ID Card
- Driving License
If confirmed:
- The file is accepted as PoA material
- The
issueDayWindowMonthsvalidity check is skipped
When allowIdDocumentAsPoa is disabled:
- Identity documents are rejected immediately
Document Format Validation
All switches in documentFormatAllowance are disabled by default.
You only need to explicitly enable specific switches when your business scenario requires accepting non-standard document formats, such as:
- photocopies
- screenshots
- scanned copies
- black-and-white prints
If not configured, the system applies the default document format validation rules.
For integration support, please contact your account manager.
Updated 4 days ago
