Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.didit.me/llms.txt

Use this file to discover all available pages before exploring further.

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.
Didit proof of address report screenshot showing extracted address fields and document type

​
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';
    issuing_state: string;    // ISO 3166-1 alpha-3
    document_type: 'UTILITY_BILL' | 'BANK_STATEMENT' | 'GOVERNMENT_ISSUED_DOCUMENT' | 'OTHER_POA_DOCUMENT' | 'UNKNOWN';
    issuer: string;
    issue_date: string;        // YYYY-MM-DD
    expiration_date: string | null;  // YYYY-MM-DD, if available
    document_language: string;
    name_on_document: string;
    poa_address: string;
    poa_formatted_address: string;
    poa_parsed_address: {
      address_type: string;
      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_metadata: {
      file_size: number | null;
      content_type: string | null;
      creation_date: string | null;
      modified_date: string | null;
      overlay_manipulation: {
        detected: boolean;
        analyzed: boolean;
        signals: string[];
        manipulated_regions: {
          page: number;
          x: number;
          y: number;
          width: number;
          height: number;
          page_width: number;
          page_height: number;
        }[];
      } | null;
    } | null;
    warnings: {
      risk: string;
      additional_data: string | null;
      log_type: 'information' | 'warning' | 'error';
      short_description: string;
      long_description: string;
    }[];
  }
}

​
Sample JSON Response

{
  "poa": {
    "status": "Approved",
    "issuing_state": "USA",
    "document_type": "BANK_STATEMENT",
    "issuer": "National Bank",
    "issue_date": "2024-05-15",
    "expiration_date": null,
    "document_language": "en",
    "name_on_document": "John A. Smith",
    "poa_address": "123 Main St, Apartment 4B, New York, NY 10001",
    "poa_formatted_address": "123 Main St, Apartment 4B, New York, NY 10001, USA",
    "poa_parsed_address": {
      "address_type": "Main St",
      "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",
    "document_metadata": {
      "file_size": 246810,
      "content_type": "application/pdf",
      "creation_date": "2024-05-15",
      "modified_date": "2024-05-15",
      "overlay_manipulation": null
    },
    "warnings": []
  }
}

​
PDF overlay-manipulation metadata

When a submitted proof-of-address document is a PDF, document_metadata.overlay_manipulation can contain forensic evidence for suspected text overlays. detected indicates whether the check found manipulation evidence; signals lists the checks that fired, such as duplicate_font_subset or glyph_fragmentation; and manipulated_regions contains page-coordinate rectangles around the suspected edited text. Each rectangle uses the PDF page coordinate space (x, y, width, height, page_width, page_height) so reviewers can highlight the affected area in a PDF preview. The field is null when no overlay evidence was found, when the document is not a PDF, or when the PDF could not be analyzed.
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.