QoreIDParams
The QoreIDParams object is how you provide data relevant to the SDK.
val params:QoreIDParams = QoreIDParams()
.clientId(key)
.customerReference(id)
.inputData(inputData)
// call other methods as described below...
.build()
Methods
clientId(key) (Required)
clientId(key) (Required)Set your QoreID client ID (as obtained from your QoreID portal).
| Arguments | Description | Required? |
|---|---|---|
key: String | Your QoreID app key | Required |
customerReference(id) (Required)
customerReference(id) (Required)Provide a value to be used as an identifier for a customer who is the subject of this verification.
| Arguments | Description |
|---|---|
id: String | String that identifies a customer in your organization. |
collection(productCode)
collection(productCode)Call this method to indicate that the SDK should be launched in Collection mode. This is required to carry out a verification in Collection mode.
| Arguments | Description |
|---|---|
productCode: String | Value representing a QoreID service product. See the list of options here - Product Codes |
workflow(workflowId)
workflow(workflowId)Call this method to indicate that the SDK should launch in Workflow mode. This is required to carry out a Workflow verification
| Arguments | Description |
|---|---|
workflowId: String | ID of a workflow you have created on your QoreID Portal dashboard |
inputData(data) (Optional)
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.
| Arguments | Description |
|---|---|
data: InputData | See the InputData section below. |
inputData(ApplicantData, AddressData, IdentityData)
inputData(ApplicantData, AddressData, IdentityData)Alternative to calling QoreIDParams.inputData(InputData)
| Arguments | Description | |
|---|---|---|
applicant: ApplicantData | Provide details about an individual Applicant. | Optional |
address: AddressData | Provide details for an address verification. | Optional |
identity: IdentityData | Provide details for an identity verification | Optional |
ocrAcceptedDocuments(values)
ocrAcceptedDocuments(values)Required for verifications that involve OCR ID document scan.
| Arguments | Description |
|---|---|
values: List<String> | See more about OCR - Accepted Documents here. |
organizationLogo(res)
organizationLogo(res)Set your organization logo.
| Arguments | Description |
|---|---|
res: Integer | Drawable resource for the image |
InputData
InputDataUsed to provide input data for the SDK verification session.
val inputData = InputData(applicant: ApplicantData, address: AddressData)
ApplicantData
ApplicantDataUsed to provide data about an individual who is the subject of a verification.
private val applicantData = ApplicantData(
"firstname",
"lastname",
"phone"
)
AddressData
AddressDataUsed this to provide address data for Verifind verifications.
private val addressData = AddressData(
address,
city,
lga,
state,
// ... Other params depending on the subject country
)
Updated over 2 years ago