TechnologiesSecurity, Privacy & Authentication

IdentityDocumentServices

iOSmacOStvOSwatchOSvisionOS

IdentityDocumentServices lets your app present and respond to ISO 18013-5 mobile identity document requests, registering documents the app can present for verification. You model incoming requests and outgoing responses with ISO18013MobileDocumentRequest and ISO18013MobileDocumentResponse, and register the documents your app provides through an IdentityDocumentProviderRegistrationStore actor using types like IdentityDocumentRegistration and MobileDocumentRegistration. For web-initiated presentment, you validate and handle requests with IdentityDocumentWebPresentmentRawRequest, IdentityDocumentWebPresentmentRawRequestValidator, IdentityDocumentWebPresentmentRequest, and IdentityDocumentWebPresentmentResponse, surfacing failures as IdentityDocumentPresentmentError. The framework is available on iOS and macOS.

Mobile Document Requests and Responses 2

Model incoming ISO 18013-5 mobile identity document requests and the responses your app returns.

  • St
    ISO18013MobileDocumentRequest
    A type that represents an incoming ISO 18013-5 mobile document request.
  • St
    ISO18013MobileDocumentResponse
    A type representing the document response from a web presentment request.

Document Registration 3

Register the identity documents your app can present for verification.

  • Ac
    IdentityDocumentProviderRegistrationStore
    A store that is used to notify the system which documents an app has available for presentment.
  • Pr
    IdentityDocumentRegistration
    A protocol that defines an identity document registration.
  • St
    MobileDocumentRegistration
    A type used for registering mobile documents.

Web Presentment 4

Validate and handle web-initiated identity document presentment requests and responses.

  • St
    IdentityDocumentWebPresentmentRawRequest
    Defines a type that represents a raw web presentment request.
  • St
    IdentityDocumentWebPresentmentRawRequestValidator
    A type that contains functions for validating the incoming web presentment raw request.
  • Pr
    IdentityDocumentWebPresentmentRequest
    A closed protocol that indicates this object is used for performing an identity document web presentment.
  • Pr
    IdentityDocumentWebPresentmentResponse
    A closed protocol that indicates this object is used to represent a web presentment response.

Errors 1

Report failures that occur while presenting an identity document.

  • St
    IdentityDocumentPresentmentError
    An error type that is thrown from the identity document web presentment controller.
← Security, Privacy & Authentication