AlAccounts
public final class AlAccounts
SDK Initialization object.
-
AlAccounts
object instance.Declaration
Swift
public static let shared: AlAccounts
-
Gets the account details, in its current status.
Declaration
Swift
public func getAccount( token: String, accountUuid: String, delegate: AccountsDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
delegate
The delegate to receive SDK updates.
-
Updates an existing account in the system.
Note
If you want to clean a nullable field set the value as an emptyString
instead ofnil
. Settingnil
will have no effect on the actual value of the field.Declaration
Swift
public func updateAccount( token: String, accountUuid: String, data: AccountUpdateRequest, delegate: AccountsDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
data
The user data to update an account.
delegate
The delegate to receive SDK updates.
-
Gets the list of addresses associated with the account. The primary address is used for Identity Verification processes.
Declaration
Swift
public func listAddresses( token: String, accountUuid: String, delegate: AccountAddressesDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
delegate
The delegate to receive SDK updates.
-
Creates an address and adds it to the account.
Declaration
Swift
public func createAddress( token: String, accountUuid: String, data: AccountAddressRequest, delegate: AccountAddressesDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
addressData
User data to create new account.
delegate
The delegate to receive SDK updates.
-
Updates an existing address in the account.
Declaration
Swift
public func updateAddress( token: String, accountUuid: String, addressUuid: String, data: AccountAddressRequest, delegate: AccountAddressesDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
addressUuid
The address uuid value.
data
Address data to update an address.
delegate
The delegate to receive SDK updates.
-
Register an
AccountDossierViewController
initialized from Interface Builder.Warning
When providing aAccountDossierData
model with theAccountDossierIntent.replace
case keep in mind that all previously added documents and the current dossier will be replaced with a new one. Consider usingAccountDossierIntent.update
if what you want is just update the current documents.Declaration
Swift
public func registerAccountDossierViewController( token: String, viewController: AccountDossierViewController, data: AccountDossierData, delegate: AccountDossiersDelegate, style: AccountDossierStyle? = nil)
Parameters
token
The token to authenticate the SDK.
viewController
The
AccountDossierViewController
view controller.data
Data model to setup dossier capture.
delegate
The delegate to receive SDK updates.
style
The style customizations object.
-
Create and returns an
AccountDossierViewController
.Warning
When providing aAccountDossierData
model with theAccountDossierIntent.replace
case keep in mind that all previously added documents and the current dossier will be replaced with a new one. Consider usingAccountDossierIntent.update
if what you want is just update the current documents.Declaration
Swift
public func createAccountDossierViewController( token: String, data: AccountDossierData, delegate: AccountDossiersDelegate, style: AccountDossierStyle? = nil) -> AccountDossierViewController
Parameters
token
The token to authenticate the SDK.
data
Data model to setup dossier capture.
delegate
The delegate to receive SDK updates.
style
The style customizations object.
Return Value
A
AccountDossierViewController
instance. -
Gets a specific dossier from the account, including the uploaded documents.
Declaration
Swift
public func getDossier( token: String, accountUuid: String, dossierUuid: String, delegate: AccountDossiersDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
dossierUuid
The dossier uuid value.
delegate
The delegate to receive SDK updates.
-
Gets the account dossiers, including all documents that have been uploaded to this account.
Declaration
Swift
public func listDossiers( token: String, accountUuid: String, delegate: AccountDossiersDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
delegate
The delegate to receive SDK updates.
-
Deletes a dossier from the system.
Declaration
Swift
public func deleteDossier( token: String, accountUuid: String, dossierUuid: String, delegate: AccountDossiersDelegate)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
dossierUuid
The dossier uuid value.
delegate
The delegate to receive SDK updates.
-
Async bindings.
See moreDeclaration
Swift
class Async
-
Gets the account details, in its current status.
Declaration
Swift
func getAccount( token: String, accountUuid: String, completion: @escaping (Result<Account, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The account uuid value.
completion
Called when the call was completed.
-
Updates an existing account in the system.
Note
If you want to clean a nullable field set the value as an emptyString
instead ofnil
. Settingnil
will have no effect on the actual value of the field.Declaration
Swift
func updateAccount( token: String, accountUuid: String, data: AccountUpdateRequest, completion: @escaping (Result<Account, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
data
The user data to update an account.
completion
Called when the call was completed.
-
Gets the list of addresses associated with the account. The primary address is used for Identity Verification processes.
Declaration
Swift
func listAddresses( token: String, accountUuid: String, completion: @escaping (Result<[AccountAddress], EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
completion
Called when the call was completed.
-
Creates an address and adds it to the account.
Declaration
Swift
func createAddress( token: String, accountUuid: String, data: AccountAddressRequest, completion: @escaping (Result<AccountAddress, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
data
User data to create new account.
completion
Called when the call was completed.
-
Updates an existing address in the account.
Declaration
Swift
func updateAddress( token: String, accountUuid: String, addressUuid: String, data: AccountAddressRequest, completion: @escaping (Result<AccountAddress, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
addressUuid
The address uuid value.
data
Address data to update an address.
completion
Called when the call was completed.
-
Gets a specific dossier from the account, including the uploaded documents.
Declaration
Swift
func getDossier( token: String, accountUuid: String, dossierUuid: String, completion: @escaping (Result<AccountDossier, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
dossierUuid
The dossier uuid value.
completion
Called when the call was completed.
-
Gets the account dossiers, including all documents that have been uploaded to this account.
Declaration
Swift
func listDossiers( token: String, accountUuid: String, completion: @escaping (Result<[AccountDossier], EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
completion
Called when the call was completed.
-
Deletes a dossier from the system.
Declaration
Swift
func deleteDossier( token: String, accountUuid: String, dossierUuid: String, completion: @escaping (Result<Bool, EventError>) -> Void)
Parameters
token
The token to authenticate the SDK.
accountUuid
The user account uuid value.
dossierUuid
The dossier uuid value.
completion
Called when the call was completed.
-
Combine bindings.
See moreDeclaration
Swift
class Futures