QoreIDParam
The QoreIDParam object is how you provide data relevant to the SDK.
From SDK v2.0.0, the SDK is launched with asessionTokenminted 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)
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.
| Arguments | Description | Required? |
|---|---|---|
token: String | The sdkSessionToken returned by POST /v1/sessions from your backend | 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. |
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. |
InputData
InputDataUsed to provide input data for the SDK verification session.
let inputData = InputData(applicant: applicant, address: addressData)ApplicantData
ApplicantDataUsed 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
AddressDataUsed 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
)