Extract ID Document Data & Face Image API
/id_extract
Performs OCR and data extraction on an Australian identity document (passport, driver licence, or Medicare card) and returns parsed identity fields plus a cropped face portrait where available. Use it when you're embedding into a custom KYC or onboarding flow and need extracted identity data without committing to the full ID Pass hosted flow.
Example Request
POSTRequest Schema
document_type
passport, licence, or medicare.
document_photo
Front of the document. JPEG only. Max 16 MB.
document_back
Required when document_type is licence. Same format and limits.
Available Response Data
6 Data Pointsresult.photo
base64-encoded cropped face image when a face is detected
result.face_occluded
false if not occluded, or a numeric confidence value when occlusion is detected
Passport
first_name, last_name, birth_date, expiry_date, gender, passport_number, country
Licence
first_name, middle_name, last_name, birth_date, address, expiry_date, conditions, licence_state, card_number
Medicare
card_color, card_number, expiry_date YYYY-MM or YYYY-MM-DD, people array (each with ref_number and name lines
API reference UUID
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Technical Use Cases tag
Embedded onboarding flows
Build your own document capture UI and post images to this endpoint. Useful when ID Pass orchestration isn't required but you need document parsing.
ID Document data prefill
Extract identity fields automatically so customers don't have to retype data already printed on their ID. Reduces onboarding friction and data-entry errors.
Face crop for downstream biometrics
Use the returned face crop as the reference image for a subsequent likeness or liveness check.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
Which document types are supported?
add
Which document types are supported?
Three. Australian passport (single image), Australian driver licence (requires both front and back images), and Medicare card (front only).
rocket_launch Implementation
What's face_occluded?
add
What's face_occluded?
false when the face is not considered occluded. When the face is considered occluded, it returns a percentage confidence that the face is occluded. Note this is not an indication of the proportion of the face that’s occluded, just the confidence in occlusion detection.
shield_lock Security
Are images logged?
add
Are images logged?
Sensitive fields and raw images are obfuscated in internal audit logs (masked with X). The API response itself returns the actual extracted values. Persist or redact them according to your own data handling policies.
API Testing Sandbox tag
Test the Extract ID Document Data & Face Image API directly in your browser with live mock data and see instant results.
rocket_launch Request Sandbox AccessAccess to live sandbox environments requires manual approval from our compliance team.
Ready to integrate Extract ID Document Data & Face Image API?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.