Didit Docs

Document Verification Report

Our document verification process performs comprehensive validation of identity 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 kyc object with the following key sections:

KYC Status: Overall session status and specific verification results
Document Details: Type and identifiers of the verified document
Personal Information: Extracted biographical data
Document Media: URLs to captured images and videos
Address Information: Structured location data
Verification Metadata: Additional verification details and timestamps

Core Response Fields

interface DocumentVerificationResponse {
  kyc: {
    status: 'Approved' | 'Declined' | 'In Review' | 'Expired' | 'Not Finished';
    ocr_status: 'Approved' | 'Declined' | 'In Review' | 'Expired' | 'Not Finished';
    epassport_status: 'Approved' | 'Declined' | 'In Review' | 'Expired' | 'Not Finished';
    document_type: string;
    document_number: string;
    personal_number: string;
    issuing_state: string;         // ISO 3166-1 alpha-3
    issuing_state_name: string;
    first_name: string;
    last_name: string;
    full_name: string;
    gender: 'M' | 'F' | 'U';
    date_of_birth: string;         // YYYY-MM-DD
    expiration_date: string;       // YYYY-MM-DD
    date_of_issue: string;        // YYYY-MM-DD
    place_of_birth: string;
    marital_status: 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'WIDOWED' | 'UNKNOWN';
    nationality: string;           // ISO 3166-1 alpha-3
    portrait_image: string;        // Temporary URL
    front_image: string;          // Temporary URL
    front_video: string;         // Temporary URL
    back_image: string;          // Temporary URL
    back_video: string;          // Temporary URL
    full_front_image: string;     // Temporary URL
    full_back_image: string;     // Temporary URL
    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;
          };
          location_type: string;
          viewport: {
            northeast: {
              lat: number;
              lng: number;
            };
            southwest: {
              lat: number;
              lng: number;
            };
          };
        };
      };
    };
    is_nfc_verified: boolean;
    created_at: string;           // ISO 8601 timestamp
  }
}

Response Fields

KYC Status

status: The overall status of the KYC session (Options: "Approved", "Declined", "In Review", "Expired", "Not Finished")
ocr_status: Status of the optical character recognition verification (Options: "Approved", "Declined", "In Review", "Expired", "Not Finished")
epassport_status: Status of the electronic passport (NFC) verification (Options: "Approved", "Declined", "In Review", "Expired", "Not Finished")

Document Information

document_type: The type of document verified (e.g., "Identity Card", "Passport", "Driver's License", or "Residence Permit")
document_number: The unique identifier of the document
personal_number: Additional identification number (if available)
issuing_state: The ISO 3166-1 alpha-3 country code of the issuing country
issuing_state_name: The full name of the issuing country

Document Media

portrait_image: URL to the extracted portrait from the document
front_image: URL to the front side image of the document
front_video: URL to the video capture of the front side
back_image: URL to the back side image of the document (if applicable)
back_video: URL to the video capture of the back side (if applicable)
full_front_image: URL to the full resolution front image
full_back_image: URL to the full resolution back image (if applicable)

Personal Information

first_name: The first name of the document holder
last_name: The last name of the document holder
full_name: The complete name as it appears on the document
gender: The gender of the document holder (Options: "M" (Male), "F" (Female), "U" (Unknown))
date_of_birth: The birth date in YYYY-MM-DD format
expiration_date: The document's expiration date in YYYY-MM-DD format
date_of_issue: The document's issue date in YYYY-MM-DD format
place_of_birth: The document holder's place of birth
marital_status: The document holder's marital status (Options: "SINGLE", "MARRIED", "DIVORCED", "WIDOWED", "UNKNOWN")
nationality: The nationality code in ISO 3166-1 alpha-3 format

Address Information

address: The full address as it appears on the document
parsed_address: A structured breakdown of the address, including:
- street_1: Primary street information
- street_2: Additional street information (if available)
- city: City name
- region: State or region
- postal_code: ZIP or postal code
- raw_results: Raw geolocation data for the address
- formatted_address: A standardized version of the full address

Verification Details

is_nfc_verified: Boolean indicating whether NFC verification was performed successfully
created_at: Timestamp of when the verification was performed

Sample JSON Response

{
  "kyc": {
    "status": "Approved",
    "ocr_status": "Approved",
    "epassport_status": "Approved",
    "document_type": "Identity Card",
    "document_number": "CAA000000",
    "personal_number": "99999999R",
    "portrait_image": "https://example.com/portrait.jpg",
    "front_image": "https://example.com/front.jpg",
    "front_video": "https://example.com/front.mp4",
    "back_image": "https://example.com/back.jpg",
    "back_video": "https://example.com/back.mp4",
    "full_front_image": "https://example.com/full_front.jpg",
    "full_back_image": "https://example.com/full_back.jpg",
    "date_of_birth": "1980-01-01",
    "expiration_date": "2031-06-02",
    "date_of_issue": "2021-06-02",
    "issuing_state": "ESP",
    "issuing_state_name": "Spain",
    "first_name": "Carmen",
    "last_name": "Española Española",
    "full_name": "Carmen Española Española",
    "gender": "F",
    "address": "Avda de Madrid 34, Madrid, Madrid",
    "formatted_address": "Avda de Madrid 34, Madrid, Madrid 28822, Spain",
    "is_nfc_verified": true,
    "place_of_birth": "Madrid",
    "marital_status": "Single",
    "nationality": "ESP",
    "parsed_address": {
      "id": "7c6280a2-fb6a-4258-93d5-2ac987cbc6ba",
      "city": "Madrid",
      "label": "Spain ID Card Address",
      "region": "Madrid",
      "street_1": "Avda de Madrid 34",
      "street_2": null,
      "postal_code": "28822",
      "raw_results": {
        "geometry": {
          "location": {
            "lat": 37.4222804,
            "lng": -122.0843428
          },
          "location_type": "ROOFTOP",
          "viewport": {
            "northeast": {
              "lat": 37.4237349802915,
              "lng": -122.083183169709
            },
            "southwest": {
              "lat": 37.4210370197085,
              "lng": -122.085881130292
            }
          }
        },
      },
    },
    "created_at": "2024-01-19T13:11:08.072587Z"
  }
}

For a complete list of possible properties and their values, please refer to our API Reference.

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 personal details. As a best practice, minimize the amount of data stored on your servers.

Supported Documents Warnings