Skip to main content

BIDDocumentProvider

public class BIDDocumentProvider

This class is responsible for all document management, including adding or removing identity documents, and any other miscellaneous documents.

Enum Values​

Parameters
RegisterDocCategoryIdentity_DocumentRepresents an identity document
Misc_DocumentRepresents a miscellaneous document
RegisterDocTypeDLRepresents a driver's license document
LIVE_IDRepresents a Live ID document
NATIONAL_IDRepresents a national ID document
PINRepresents PIN document
PPTRepresents passport document
SSNRepresents social security number document

Method Summary​

Parameters
IntgetDocumentCount()Returns enrolled document count.
StringgetEnrolledDocumentList()Returns a list of all the documents
StringgetUserDocument(id: String?, type: String?, category: String?)Checks and returns document based on the given criteria. All or any of the input parameters can be NULL. If all the parameters are NULL, the method returns a list of all the documents registered

Method Details​

getDocumentCount​

public func getDocumentCount() -> Int

  • Returns enrolled document count.

getEnrolledDocumentList​

public func getEnrolledDocumentList() -> String

  • Returns the list of all documents.

getUserDocument​

public func getUserDocument(id: String?, type: String?, category: String?) -> String?

  • Checks and returns document based on given criteria. All or any of the input parameter can be NULL. If all the parameter will be NULL, the method returns list of all documents registered.
Parameters
idString: The number for which the user has requested the document.
typeString: The type of document (DL, PPT, etc.).
categoryString: The category of document (identity_document, misc_document)