PDF Verification

Identity verification via a France Identite certificate PDF.

How it works

PDF verification uses an official document generated by the France Identite service. The full flow, from your user's perspective:

  1. Your site displays the ZYKAY widget (QR code on desktop, button on mobile)
  2. The user scans the QR code or presses the button
  3. ZYKAY app opens on phone
  4. The user selects their France Identite certificate PDF
  5. The ZYKAY server validates the document
  6. A grant_code is returned to the widget on your site
  7. Your backend exchanges the grant_code via POST /v1/exchange

The PDF must come from the France Identite (opens in a new tab) attestation service. Other documents (scanned identity card, passport, etc.) are not accepted.

Scopes available

PDF verification supports all ZYKAY scopes:

ScopeDescriptionReturned attribute
isAdultAt 18 years or olderage_over_18: true
isFrenchFrench nationalityis_french: true
isEUCitizen of the European Unionis_eu: true
isMaleMale genderis_male: true
isFemaleFemale genderis_female: true
isUniqueUnique identifier per applicationnullifier: "0x..."
revealNationalityISO nationality codenationality: "FRA"
revealBirthYearYear of birthbirth_year: 1990

For the complete scope reference, see Available Scopes.

Frontend integration

No additional attributes are needed for PDF verification. This is the widget's default mode:

<script src="https://widget-app.zykay.com/v4/loader.min.js"
        data-partner-id="pk_live_xxx"
        data-success-path="/verified"
        data-scopes="isAdult,isFrench"></script>

For all available attributes, see Frontend Integration.

Next steps