Skip to main content

NFC / ePassport API

Verify an ePassport chip with real ICAO 9303 cryptographic checks: passive authentication (SOD signature), active authentication (RSA/ECDSA challenge), and chip authentication (ECDH key agreement).

POST /verifications/{id}/nfc
Authorization: Bearer vyd_xxx
Content-Type: application/json

Permissions​

Requires nfc:run permission.

Request Body (JSON)​

FieldTypeRequiredDescription
mrz_dataobjectYesMRZ fields read from the passport (document_number, issuing_state, names, nationality, date_of_birth, sex, date_of_expiry, optional_data)
security_objectobjectYesThe LDS Security Object (SOD): hash_algorithm, data_group_hashes, signature, issuer_certificate
chip_infoobjectYesChip metadata (chip_type, document_type, issued_state, dates, supported_interfaces)
data_groupsobjectYesRaw data-group bytes, keyed by DG number ("DG1", "DG2", …) as base64
facial_imagestringNoBase64 facial image (DG2)
active_auth_responsestringNoSigned challenge (base64) for active authentication
active_auth_public_keystringNoChip public key for active authentication
chip_auth_picc_keystringNoChip PICC public key for chip authentication
chip_auth_terminal_keystringNoTerminal public key for chip authentication

Response​

{
"passed": true,
"passive_auth": { "passed": true, "details": {} },
"active_auth": { "passed": true },
"chip_auth": { "passed": true },
"mrz_data": { "document_number": "L898902C", "names": "ERIKSSON ANNA MARIA" },
"chip_info": { "chip_type": "ePassport" }
}
FieldTypeDescription
passedbooleanOverall NFC verification result
passive_authobjectSOD signature + data-group hash verification
active_authobjectChallenge-response signature verification (optional)
chip_authobjectECDH chip authentication result (optional)
mrz_dataobjectParsed MRZ data
chip_infoobjectChip metadata