Create New KYC Profile

post

https://endpoint.example.com/profile

Before KYC and ID Scan can be performed, API user must create a new KYC profile, KYC profile allows user to define how the document should be processed, with customizable thresholds that can be adjusted to suit different kind of industries.

Body Params

Full JSON payload must be included in the payload.

name

string

required

length ≥ 1

Profile Name

canvasSize

number

required

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.

orientationCorrection

boolean

required

Correct image orientation for rotated images

objectDetection

boolean

required

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

AAMVABarcodeParsing

boolean

required

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.

saveResult

boolean

required

Whether transaction results should be saved

saveImage

boolean

required

If saveResult is enabled, whether output images should also be saved on cloud.

outputImage

boolean

required

Whether to return output image as part of API response

outputType

string

required

length ≥ 1

Output processed image in either "base64" or "url".

crop

boolean

required

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

advancedCrop

boolean

required

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

outputSize

number

required

Maximum pixel width/height for output & saved image.

inferFullName

boolean

required

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

splitFirstName

boolean

required

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

transactionAuditReport

boolean

required

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

timezone

string

required

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.

obscure

array of strings

required

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

obscure*

webhook

string

required

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

thresholds

object

required

Control the threshold of Document Validation Components, numbers should be float between 0 to 1.

decisionTrigger

object

required

For every failed validation

decisions

object

required

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

docupass

object

required

Docupass express identity verification / e-signature module settings

acceptedDocuments

object

required

Only accept specified type of document from specific countries and/or states.

Response

200OK