AccountDossierCaptureRequest

public enum AccountDossierCaptureRequest

Data model to setup dossier capture.

  • The data needed to create a dossier.

    Declaration

    Swift

    case create(_ documentTypes: [DocumentType],
            accountUuid: String,
            isPrimary: Bool,
            externalId: String,
            realTimeVerification: Bool = false,
            countryOfIssuance: String? = nil)

    Parameters

    documentTypes

    The list of document types to capture.
    accountUuid

    The user account id.
    isPrimary

    Whether the dossier is primary or not. There can only be one primary dossier.
    externalId

    This is your unique ID for this dossier. This field is used to guarantee idempotency.
    realTimeVerification

    Whether the dossier should be verified in real time.
    countryOfIssuance

    The country of issuance.

  • The data needed to update a dossier.

    Declaration

    Swift

    case update(_ documentTypes: [DocumentType],
            accountUuid: String,
            dossierUuid: String,
            externalId: String? = nil,
            realTimeVerification: Bool = false,
            countryOfIssuance: String? = nil)

    Parameters

    documentTypes

    The list of document types to capture.
    accountUuid

    The user account id.
    dossierUuid

    The account dossier id.
    externalId

    This is your unique ID for this dossier. This field is used to guarantee idempotency.
    realTimeVerification

    Whether the dossier should be verified in real time.
    countryOfIssuance

    The country of issuance.

  • The data needed to replace a dossier.

    Declaration

    Swift

    case replace(_ documentTypes: [DocumentType],
             accountUuid: String, dossierUuid: String,
             externalId: String? = nil,
             realTimeVerification: Bool = false,
             countryOfIssuance: String? = nil)

    Parameters

    documentTypes

    The list of document types to capture.
    accountUuid

    The user account id.
    dossierUuid

    The account dossier id.
    externalId

    This is your unique ID for this dossier. This field is used to guarantee idempotency.
    realTimeVerification

    Whether the dossier should be verified in real time.
    countryOfIssuance

    The country of issuance.

  • The data needed to capture a dossier.

    Declaration

    Swift

    case capture(_: [DocumentType])

    Parameters

    documentTypes

    The list of document types to capture.