QoreIDParam

The QoreIDParam object is how you provide data relevant to the SDK.

👍

From SDK v2.0.0, the SDK is launched with a sessionToken minted by your backend — the product or workflow is encoded inside the session token. See SDK Session Tokens.

let param:QoreIDParam = QoreIDParam()
  .sessionToken(sessionToken)
  .customerReference(id)
  .inputData(inputData)
  // call other methods as described below...
  .build()

Methods

sessionToken(token) (Required)

Set the SDK session token minted by your backend via POST /v1/sessions. The token determines whether the SDK runs in Collection or Workflow mode and which product or workflow it is scoped to. Tokens are short-lived and single-use.

ArgumentsDescriptionRequired?
token: StringThe sdkSessionToken returned by POST /v1/sessions from your backendRequired

customerReference(id) (Required)

Provide a value to be used as an identifier for a customer who is the subject of this verification.

ArgumentsDescription
id: StringString that identifies a customer in your organization.

inputData(data) (Optional)

Use this to provide input data about the target of the verification. If not provided, the end-user will be asked to provide the data in a form, where needed.

ArgumentsDescription
data: InputDataSee the InputData section below.

inputData(ApplicantData, AddressData, IdentityData)

Alternative to calling QoreIDParams.inputData(InputData)

ArgumentsDescription
applicant: ApplicantDataProvide details about an individual Applicant.Optional
address: AddressDataProvide details for an address verification.Optional
identity: IdentityDataProvide details for an identity verificationOptional

ocrAcceptedDocuments(values)

Required for verifications that involve OCR ID document scan.

ArgumentsDescription
values: List<String>See more about OCR - Accepted Documents here.

InputData

Used to provide input data for the SDK verification session.

let inputData = InputData(applicant: applicant, address: addressData)

ApplicantData

Used to provide data about an individual who is the subject of a verification.

private let applicant = ApplicantData(firstname: firstname,
                                      lastname:lastname,
                                      phone: phone,
                                      email: email)

AddressData

Used this to provide address data for Verifind verifications.

   private let addressData = AddressData(address: address, 
                                         city: city, 
                                         lga: lga,
                                         state: state,
  // ... Other params depending on the subject country
)