Our ID 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 id_verification object with the following key sections:
- ID Verification 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 {
id_verification: {
status: 'Approved' | 'Declined' | 'In Review' | 'Expired' | 'Not Finished';
document_type: string;
document_number: string;
personal_number: string;
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
date_of_birth: string; // YYYY-MM-DD
age: number;
expiration_date: string; // YYYY-MM-DD
date_of_issue: string; // YYYY-MM-DD
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';
address: string;
formatted_address: string;
place_of_birth: string;
marital_status: 'SINGLE' | 'MARRIED' | 'DIVORCED' | 'WIDOWED' | 'UNKNOWN';
nationality: string; // ISO 3166-1 alpha-3
extra_fields: {
dl_categories: string[];
blood_group: 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;
};
};
};
};
};
extra_files: string[];
warnings: {
risk: string;
additional_data: string | null;
log_type: 'information' | 'warning' | 'error';
short_description: string;
long_description: string;
}[];
}
}Sample JSON Response
{
"id_verification": {
"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",
"age": 45,
"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",
"place_of_birth": "Madrid",
"marital_status": "Single",
"nationality": "ESP",
"extra_fields": {
"dl_categories": [],
"blood_group": null
},
"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
}
}
},
},
},
"extra_files": [
"https://example.com/extra_id_verification.jpg",
],
"warnings": [
{
"risk": "QR_NOT_DETECTED",
"additional_data": null,
"log_type": "information",
"short_description": "QR not detected",
"long_description": "The system couldn't find or read the QR code on the document, which is necessary for document verification. This could be due to poor image quality or an unsupported document type.",
}
],
},
}For more information about potential warnings during the ID verification process, check our ID Verification 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 personal details. As a best practice, minimize the amount of data stored on your servers.