Proof of Address Verification Report
Our Proof of Address verification process performs comprehensive validation of address documents, extracting and verifying key information. This guide explains the structure and contents of a verification report.
Report Structure
The verification report is returned as a JSON object containing a poa
object with the following key sections:
- PoA Status: Overall verification status of the address document
- Document Details: Type and information about the verified document
- Address Information: Extracted address data in both raw and structured formats
- Document Media: URLs to captured document images
- Verification Metadata: Additional verification details and timestamps
Core Response Fields
interface ProofOfAddressVerificationResponse {
poa: {
status: 'Approved' | 'Declined' | 'In Review' | 'Not Finished';
document_type: string;
issuer: string;
issue_date: string; // YYYY-MM-DD
address: string;
formatted_address: string;
parsed_address: {
street_1: string;
street_2: string;
city: string;
region: string;
postal_code: string;
raw_results: {
geometry: {
location: {
lat: number;
lng: number;
};
};
};
};
document_file: string; // Temporary URL
document_language: string;
name_on_document: string;
name_match_score: number;
warnings: {
risk: string;
additional_data: string | null;
log_type: 'information' | 'warning' | 'error';
short_description: string;
long_description: string;
}[];
}
}
Response Fields
PoA Status
status
: The overall status of the address verification (Options: "Approved", "Declined", "In Review", "Expired", "Not Finished")
Document Information
document_type
: The type of document verified (e.g., "Utility Bill", "Bank Statement", "Credit Card Statement")issuer
: The institution or company that issued the documentissue_date
: The document's issue date in YYYY-MM-DD formatdocument_language
: The detected language of the document
Address Information
address
: The full address as it appears on the documentname_on_document
: The name of the recipient as it appears on the documentname_match_score
: A numerical value between 0 and 100 indicating the match percentage between the name on the document and the verified identityformatted_address
: A standardized version of the full addressparsed_address
: A structured breakdown of the address, including:street_1
: Primary street informationstreet_2
: Additional street information (if available)city
: City nameregion
: State or regionpostal_code
: ZIP or postal coderaw_results
: Geolocation data for the address, including latitude and longitude
Document Media
document_file
: URL to the document image(s)
Verification Details
warnings
: Array of warning objects with detailed information about verification issues
Sample JSON Response
{
"poa": {
"status": "Approved",
"document_type": "Bank Statement",
"issuer": "National Bank",
"issue_date": "2024-05-15",
"document_language": "EN",
"name_on_document": "John A. Smith",
"name_match_score": 92.5,
"address": "123 Main St, Apartment 4B, New York, NY 10001",
"formatted_address": "123 Main St, Apartment 4B, New York, NY 10001, USA",
"parsed_address": {
"street_1": "123 Main St",
"street_2": "Apartment 4B",
"city": "New York",
"region": "NY",
"postal_code": "10001",
"raw_results": {
"geometry": {
"location": {
"lat": 40.7128,
"lng": -74.0060
}
}
}
},
"document_file": "https://example.com/poa_document.pdf",
"warnings": []
}
}
For more information about potential warnings during the proof of address verification process, check our Proof of Address Warnings guide.
Security Note
The URLs provided for document images are temporary and expire after 60 minutes for enhanced security. Ensure these URLs are handled with appropriate security measures and are not shared publicly. Typically, your application will only require the verification status and essential address details. As a best practice, minimize the amount of data stored on your servers.