Documentation

Profile

Table of Contents

$profileId  : mixed
$profileOverride  : mixed
$SECURITY_HIGH  : mixed
$SECURITY_LOW  : mixed
$SECURITY_MEDIUM  : mixed
$SECURITY_NONE  : mixed
$URL_VALIDATION_REGEX  : mixed
__construct()  : mixed
Initialize KYC Profile
AAMVABarcodeParsing()  : void
Enable to parse AAMVA barcode for US/CA ID/DL. Disable this to improve performance if you are not planning on scanning ID/DL from US or Canada.
autoCrop()  : void
Crop image before saving and returning output
canvasSize()  : void
Canvas Size in pixels, input image larger than this size will be scaled down before further processing, reduced image size will improve inference time but reduce result accuracy. Set 0 to disable image resizing.
decisionTrigger()  : void
Set decision trigger value
inferFullName()  : void
Generate a full name field using parsed first name, middle name and last name.
loadFromJson()  : void
Set profile configuration with provided JSON string
objectDetection()  : void
Enable to automatically detect and return the locations of signature, document and face.
obscure()  : void
A list of data fields key to be redacted before transaction storage, these fields will also be blurred from output & saved image.
orientationCorrection()  : void
Correct image orientation for rotated images
outputImage()  : void
Whether to return output image as part of API response
outputSize()  : void
Maximum width/height in pixels for output and saved image.
restrictDocumentCountry()  : void
Check if the document was issued by specified countries. Separate multiple values with comma. For example "US,CA" would accept documents from the United States and Canada.
restrictDocumentState()  : void
Check if the document was issued by specified state. Separate multiple values with comma. For example "CA,TX" would accept documents from California and Texas.
restrictDocumentType()  : void
Check if the document was one of the specified types. For example, "PD" would accept both passport and driver license.
saveResult()  : void
Whether scan transaction results and output images should be saved on cloud
setTimezone()  : void
Set timezone for audit reports. If left blank, UTC will be used. Refer to https://en.wikipedia.org/wiki/List_of_tz_database_time_zones TZ database name list.
setWarning()  : void
Enable/Disable and fine-tune how each Document Validation Component affects the final decision.
splitFirstName()  : void
If first name contains more than one word, move second word onwards into middle name field.
threshold()  : void
Set validation threshold of a specified component
transactionAuditReport()  : void
Enable to generate a detailed PDF audit report for every transaction.
webhook()  : void
Enter a server URL to listen for Docupass verification and scan transaction results

Properties

$profileId

public mixed $profileId = ""

$profileOverride

public mixed $profileOverride = array()

$SECURITY_HIGH

public static mixed $SECURITY_HIGH = "security_high"

$SECURITY_LOW

public static mixed $SECURITY_LOW = "security_low"

$SECURITY_MEDIUM

public static mixed $SECURITY_MEDIUM = "security_medium"

$SECURITY_NONE

public static mixed $SECURITY_NONE = "security_none"

$URL_VALIDATION_REGEX

private mixed $URL_VALIDATION_REGEX = "#(?i)\b((?:[a-z][\w-]+:(?:/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:'".,<>?«»“”‘’]))#iS"

Methods

__construct()

Initialize KYC Profile

public __construct(string $profileId) : mixed
Parameters
$profileId : string

Custom profile ID or preset profile (security_none, security_low, security_medium, security_high). SECURITY_NONE will be used if left blank.

Tags
throws
Exception
Return values
mixed —

AAMVABarcodeParsing()

Enable to parse AAMVA barcode for US/CA ID/DL. Disable this to improve performance if you are not planning on scanning ID/DL from US or Canada.

public AAMVABarcodeParsing(bool $enabled) : void
Parameters
$enabled : bool
Return values
void —

autoCrop()

Crop image before saving and returning output

public autoCrop(bool $enableAutoCrop, bool $enableAdvancedAutoCrop) : void
Parameters
$enableAutoCrop : bool

Enable to automatically remove any irrelevant pixels from the uploaded image before saving and outputting the final image.

$enableAdvancedAutoCrop : bool

Enable to use advanced deskew feature on documents that are sheared.

Return values
void —

canvasSize()

Canvas Size in pixels, input image larger than this size will be scaled down before further processing, reduced image size will improve inference time but reduce result accuracy. Set 0 to disable image resizing.

public canvasSize(int $pixels) : void
Parameters
$pixels : int
Return values
void —

decisionTrigger()

Set decision trigger value

public decisionTrigger([int $reviewTrigger = 1 ][, int $rejectTrigger = 1 ]) : void
Parameters
$reviewTrigger : int = 1

If the final total review score is equal to or greater than this value, the final KYC decision will be "review"

$rejectTrigger : int = 1

If the final total review score is equal to or greater than this value, the final KYC decision will be "reject". Reject has higher priority than review.

Return values
void —

inferFullName()

Generate a full name field using parsed first name, middle name and last name.

public inferFullName(bool $enabled) : void
Parameters
$enabled : bool
Return values
void —

loadFromJson()

Set profile configuration with provided JSON string

public loadFromJson(string $jsonString) : void
Parameters
$jsonString : string

JSON string containing profile information

Return values
void —

objectDetection()

Enable to automatically detect and return the locations of signature, document and face.

public objectDetection(bool $enabled) : void
Parameters
$enabled : bool
Return values
void —

obscure()

A list of data fields key to be redacted before transaction storage, these fields will also be blurred from output & saved image.

public obscure(array<string|int, mixed> $fieldKeys) : void
Parameters
$fieldKeys : array<string|int, mixed>
Tags
throws
InvalidArgumentException
Return values
void —

orientationCorrection()

Correct image orientation for rotated images

public orientationCorrection(bool $enabled) : void
Parameters
$enabled : bool
Return values
void —

outputImage()

Whether to return output image as part of API response

public outputImage(bool $enableOutputImage[, string $outputFormat = "url" ]) : void
Parameters
$enableOutputImage : bool
$outputFormat : string = "url"

"url" or "base64"

Return values
void —

outputSize()

Maximum width/height in pixels for output and saved image.

public outputSize(int $pixels) : void
Parameters
$pixels : int
Return values
void —

restrictDocumentCountry()

Check if the document was issued by specified countries. Separate multiple values with comma. For example "US,CA" would accept documents from the United States and Canada.

public restrictDocumentCountry([string $countryCodes = "US,CA,UK" ]) : void
Parameters
$countryCodes : string = "US,CA,UK"

ISO ALPHA-2 Country Code separated by comma

Return values
void —

restrictDocumentState()

Check if the document was issued by specified state. Separate multiple values with comma. For example "CA,TX" would accept documents from California and Texas.

public restrictDocumentState([string $states = "CA,TX" ]) : void
Parameters
$states : string = "CA,TX"

State full name or abbreviation separated by comma

Return values
void —

restrictDocumentType()

Check if the document was one of the specified types. For example, "PD" would accept both passport and driver license.

public restrictDocumentType([string $documentType = "DIP" ]) : void
Parameters
$documentType : string = "DIP"

P: Passport, D: Driver's License, I: Identity Card

Return values
void —

saveResult()

Whether scan transaction results and output images should be saved on cloud

public saveResult(bool $enableSaveTransaction, bool $enableSaveTransactionImages) : void
Parameters
$enableSaveTransaction : bool
$enableSaveTransactionImages : bool
Return values
void —

setTimezone()

Set timezone for audit reports. If left blank, UTC will be used. Refer to https://en.wikipedia.org/wiki/List_of_tz_database_time_zones TZ database name list.

public setTimezone(string $timezone) : void
Parameters
$timezone : string
Return values
void —

setWarning()

Enable/Disable and fine-tune how each Document Validation Component affects the final decision.

public setWarning([int $code = "UNRECOGNIZED_DOCUMENT" ][, bool $enabled = true ][, float $reviewThreshold = -1 ], float $rejectThreshold[, int $weight = 1 ]) : void
Parameters
$code : int = "UNRECOGNIZED_DOCUMENT"

Document Validation Component Code / Warning Code

$enabled : bool = true

Enable the current Document Validation Component

$reviewThreshold : float = -1

If the current validation has failed to pass, and the specified number is greater than or equal to zero, and the confidence of this warning is greater than or equal to the specified value, the "total review score" will be added by the weight value.

$rejectThreshold : float

If the current validation has failed to pass, and the specified number is greater than or equal to zero, and the confidence of this warning is greater than or equal to the specified value, the "total reject score" will be added by the weight value.

$weight : int = 1

Weight to add to the total review and reject score if the validation has failed to pass.

Return values
void —

splitFirstName()

If first name contains more than one word, move second word onwards into middle name field.

public splitFirstName(bool $enabled) : void
Parameters
$enabled : bool
Return values
void —

threshold()

Set validation threshold of a specified component

public threshold(string $thresholdKey, float $thresholdValue) : void
Parameters
$thresholdKey : string
$thresholdValue : float
Return values
void —

transactionAuditReport()

Enable to generate a detailed PDF audit report for every transaction.

public transactionAuditReport(bool $enabled) : void
Parameters
$enabled : bool
Return values
void —

webhook()

Enter a server URL to listen for Docupass verification and scan transaction results

public webhook([string $url = "https://www.example.com/webhook.php" ]) : void
Parameters
$url : string = "https://www.example.com/webhook.php"
Tags
throws
InvalidArgumentException
Return values
void —

Search results