VerifyPhotoId
POST/verify/photo-id
Experimental (beta): This feature is new and currently in beta.
This endpoint extracts details from a photo ID, validates the fields, and optionally matches the document photo to a face scan.
You provide:
sub_type(required) - must be one of:PassportNationalId(MRZ-enabled IDs only)DrivingLicence(GB and EU countries)PASSCard(including Citizencard and Young Scot)UnfamiliarPhotoId
front(required) - the front of the photo ID document.back(NationalIdonly) - the back of the photo ID document.country_code(DrivingLicenceonly) - the issuing country as an ISO 3166-1 alpha-2 (e.g.GB,DE,FR).face_scan(optional) - a face image to compare with the photo on the document.
File requirements: Max 10MB per file; JPEG or PNG only.
Sandbox testing: In sandbox mode, the endpoint returns a mock “pass” response. It echoes back your reference values. It does not process the document.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 501
- 503
Verification completed successfully
Bad request - invalid payload or share code format
Unauthorised
Trial expired or feature not available on your plan
Unprocessable entity - share code has been locked out by GOV.UK
Not implemented - RightToWork and RightToRent are coming soon
Service temporarily unavailable