ID Analyzer (Preview)
ID Analyzer provides several different identity verification products, you need to acquire basic knowledge of each product in order to choose the best solution for your application.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | ID Analyzer Support |
URL | https://www.idanalyzer.com/contact.html |
support@idanalyzer.com |
Connector Metadata | |
---|---|
Publisher | Evith Techology |
Website | https://www.idanalyzer.com/ |
Privacy policy | https://www.idanalyzer.com/privacy-policy.html |
Categories | IT Operations;Productivity |
The ID Analyzer platform provides businesses, organizations, and individuals with a truly global identity verification solution that works without borders, a solution that can be tailored to your specific needs and demands, and a security system that is constantly being upgraded and improved.
Providing full identity verification access and information across more than 4000+ different forms of ID in 190+ countries around the world, this is very much a global solution designed with the modern world in mind.
- A developer account with ID Analyzer. You can register for a free account at Sign Up
- After registering for the account, you will be given an API key in ID Analyzer's web portal. Use this API key to authenticate with the connector
- Navigate to Sign Up
- Enter in the required information.
- Verify your email when prompted to do so.
- You will see your new API key in ID Analyzer's web portal with your account details. Press the "Copy" button to save it to your clipboard for later use.
Everything will be stored only in the client's vault and will not be arbitrarily leaked. It will not have any copy in other place.
Remaining prepaid credit for your account. If you have a monthly plan, your monthly quota will be used before prepaid credit.
Turn on authentication, the result will contain authentication score.
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API API Key | securestring | The API Key for this api | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Add Image To Vault |
You can upload an image and add it to an existing vault entry by making HTTP POST request. |
Core API Setting |
Multi-function ID verification API to verify remote physical document, its authenticity and face match the document with your user photo. |
Creating Docu |
You can create a verification session for every user requiring identity verification. |
Creating Docu |
You can create a signature session where user will review and e-sign legal document without identity verification. If you want to perform both identity verification and have your user sign some document, please create an identity verification session instead. |
Delete Entry From Vault |
You can delete single or multiple vault entries by making HTTP POST request. |
Delete Image From Vault |
You can delete an image inside a vault entry by making HTTP POST request. Note that after an image is deleted, the URL to the image may still be accessible for a short-period of time due to caching. |
Face Search |
Face search allows you to search the entire vault using an image of a person. To use face search feature, you must enable face search indexing under web portal, and train your vault datasets periodically. |
Face Search Training |
Before performing face search, you must issue a train command to train the document datasets inside your vault. You may also train your vault data through web portal. The training task is asynchronous, training time depends on the number of vault entries and images. It could take from several seconds to an hour. |
Get Vault Entry Content |
When entries are added to the vault, both Core API and DocuPass API will return a vault entry identifier named vaultid. You can use the identifier to query the content of an entry in the vault by submitting an HTTP POST request to the following endpoint. |
List and Filter Entries |
To list all the entries stored inside the vault or search for entries with specific values, send an HTTP POST request to the following endpoint. |
Searching AML Database |
AML API allows you to search ID Analyzer global AML database for sanctions, PEPs and wanted criminals using either a name, document number or both. You may further filter the results with birthday and nationality. |
Training Status |
Check whether vault training is still ongoing or has completed. |
Update Vault Entry |
You can update the value of a single field or values of multiple fields in a vault entry by making HTTP POST request. |
Validating Callback |
To make sure the data was sent from our server. |
You can upload an image and add it to an existing vault entry by making HTTP POST request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
id
|
id | True | string |
Vault entry identifier to add image to |
type
|
type | True | string |
Set the type of image: 0=document and 1=person |
image
|
image | string |
Base64-encoded image data. |
|
imageurl
|
imageurl | string |
Remote image URL. |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | integer | |
id
|
image.id | string |
Image identifier |
type
|
image.type | string |
0 for document and 1 for person |
hash
|
image.hash | string |
MD5 hash of image |
url
|
image.url | string |
URL to the image |
createtime
|
image.createtime | string |
Time image was uploaded in UTC |
Multi-function ID verification API to verify remote physical document, its authenticity and face match the document with your user photo.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your web portal. |
file_base64
|
file_base64 | string |
You can upload a base64-encoded image as a string using application/x-www-form-urlencoded or application/json. |
|
url
|
url | string |
Core API is capable of downloading remote image from your server. |
|
file_back_base64
|
file_back_base64 | string |
Base64-encoded image of the back of the document to perform a dual-side scan. |
|
url_back
|
url_back | string |
Remote image of the back of the document to perform a dual-side scan. |
|
face_base64
|
face_base64 | string |
Base64-encoded image of a person's face to perform photo biometric verification. |
|
faceurl
|
faceurl | string |
Remote image of of a person's face to perform photo biometric verification. |
|
video_base64
|
video_base64 | string |
Base64-encoded selfie video to perform video biometric verification. |
|
videourl
|
videourl | string |
Remote hosted selfie video to perform video biometric verification. |
|
passcode
|
passcode | string |
4 digit number |
|
accuracy
|
accuracy | integer |
Configure the speed and accuracy of document recognition and ocr results. Low accuracy will reduce response time to under 1 second while high accuracy will generally takes 2~3 seconds. |
|
authenticate
|
authenticate | boolean |
Validate the document to check whether the document is authentic and has not been tampered. |
|
authenticate_module
|
authenticate_module | string |
Specify module used for validating the document. |
|
biometric_threshold
|
biometric_threshold | float |
Specify the minimum score to pass facial biometric verification |
|
return_confidence
|
return_confidence | boolean |
Return confidence score for each data field. |
|
return_empty
|
return_empty | boolean |
You can get the API to return null on empty fields by enabling this parameter. |
|
ocr_scaledown
|
ocr_scaledown | integer |
Number between 500 to 4000 or 0 |
|
outputimage
|
outputimage | boolean |
Produce a cropped image of the document. |
|
outputface
|
outputface | boolean |
Produce a cropped image of the face region on the document. |
|
outputmode
|
outputmode | string |
Output the cropped document and face as either URL or base64-encoded content. |
|
dualsidecheck
|
dualsidecheck | boolean |
Check if the names, document number and document type matches between the front and the back of the document when performing dual-side scan. If any information mismatches error 14 will be thrown. |
|
verify_expiry
|
verify_expiry | boolean |
Check if the document is still valid based on its expiry date. |
|
verify_documentno
|
verify_documentno | string |
Check if supplied document number matches with document. |
|
verify_dob
|
verify_dob | string |
Check if supplied date of birth matches with document. (YYYY/MM/DD) |
|
verify_age
|
verify_age | string |
Check if the document holder is aged between the given range. (range, example: 18-40) |
|
verify_address
|
verify_address | string |
Check if supplied address matches with document. |
|
verify_postcode
|
verify_postcode | string |
Check if supplied postcode matches with document. |
|
country
|
country | string |
Check if the document was issued by specified countries, if not error code 10 will be thrown. Separate multiple values with comma. For example "US,CA" would accept documents from United States and Canada. |
|
region
|
region | string |
Check if the document was issued by specified state, if not error code 11 will be thrown. Separate multiple values with comma. For example "CA,TX" would accept documents from California and Texas. |
|
type
|
type | string |
Check if the document was one of the specified types, if not error code 12 will be thrown. For example "PD" would accept both passport and drivers license. |
|
checkblocklist
|
checkblocklist | boolean |
Check the document data against blocked entries in your vault. If the document matches one of the blocked entry error 15 will be thrown |
|
vault_save
|
vault_save | boolean |
Save document image and parsed information in your secured vault. You can list, search and update document entries in your vault through Vault API or web portal. |
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
Save document image in your vault even if the document cannot be recognized. |
|
vault_noduplicate
|
vault_noduplicate | boolean |
Prevent duplicated images from being saved. |
|
vault_automerge
|
vault_automerge | boolean |
Automatically merge images with same document number into a single entry inside vault. |
|
vault_customdata1
|
vault_customdata1 | string |
Add up to 5 custom strings that will be associated with the vault entry, this can be useful for filtering and searching entries. |
|
vault_customdata2
|
vault_customdata2 | string |
Add up to 5 custom strings that will be associated with the vault entry, this can be useful for filtering and searching entries. |
|
vault_customdata3
|
vault_customdata3 | string |
Add up to 5 custom strings that will be associated with the vault entry, this can be useful for filtering and searching entries. |
|
vault_customdata4
|
vault_customdata4 | string |
Add up to 5 custom strings that will be associated with the vault entry, this can be useful for filtering and searching entries. |
|
vault_customdata5
|
vault_customdata5 | string |
Add up to 5 custom strings that will be associated with the vault entry, this can be useful for filtering and searching entries. |
|
aml_check
|
aml_check | boolean |
Check document holder's name and document number against ID Analyzer AML Database. |
|
aml_database
|
aml_database | string |
Separate each database code with comma, for example: un_sc,us_ofac. |
|
aml_strict_match
|
aml_strict_match | boolean |
Enable this parameter to reduce false-positives by only matching entities with exact same nationality and birthday. |
|
contract_generate
|
contract_generate | string |
Contract template ID to autofill with user data. |
|
contract_format
|
contract_format | string |
Output document format. Optionals: PDF, DOCX, HTML. |
|
contract_prefill_data
|
contract_prefill_data | object |
Returns
Name | Path | Type | Description |
---|---|---|---|
documentNumber
|
result.documentNumber | string |
Unique identifier associated with the document (e.g. Passport No./Driver License No./Card Number etc) |
personalNumber
|
result.personalNumber | string |
Unique personal identifier associated with the person within a country (e.g. National ID Number) |
firstName
|
result.firstName | string |
First name / Given name |
lastName
|
result.lastName | string |
Last name / Family name |
middleName
|
result.middleName | string |
Middle name(s) |
fullName
|
result.fullName | string |
If the first name and last name cannot be distinguished full name will be returned instead |
firstName_local
|
result.firstName_local | string |
First name in local language if available |
lastName_local
|
result.lastName_local | string |
Last name in local language if available |
middleName_local
|
result.middleName_local | string |
Middle name in local language if available |
fullName_local
|
result.fullName_local | string |
Full name in local language if available |
sex
|
result.sex | string |
Gender M=Male F=Female X=Unspecified |
height
|
result.height | string |
Height of person |
weight
|
result.weight | string |
Weight of person |
hairColor
|
result.hairColor | string |
Hair Color - ANSI D-20 hair color code (3 letters) |
eyeColor
|
result.eyeColor | string |
Eye Color - ANSI D-20 eye color code (3 letters) |
age
|
result.age | integer |
Age of the document holder |
dob
|
result.dob | string |
Date of birth in YYYY/MM/DD |
dob_day
|
result.dob_day | integer |
Date of birth day 1 to 31 |
dob_month
|
result.dob_month | integer |
Date of birth month 1 to 12 |
dob_year
|
result.dob_year | integer |
Date of birth year in YYYY |
expiry
|
result.expiry | string |
Expiry date of document in YYYY/MM/DD |
expiry_day
|
result.expiry_day | integer |
Day of expiry 1 to 31 |
expiry_month
|
result.expiry_month | integer |
Month of expiry 1 to 12 |
expiry_year
|
result.expiry_year | integer |
Year of expiry in YYYY |
daysToExpiry
|
result.daysToExpiry | integer |
Number of days before the document expires |
issued
|
result.issued | string |
Date of issue in YYYY/MM/DD |
issued_day
|
result.issued_day | integer |
Day of issue 1 to 31 |
issued_month
|
result.issued_month | integer |
Month of issue 1 to 12 |
issued_year
|
result.issued_year | integer |
Year of issue in YYYY |
daysFromIssue
|
result.daysFromIssue | integer |
Number of days since the document was issued |
address1
|
result.address1 | string |
Address line 1 |
address2
|
result.address2 | string |
Address line 2 |
postcode
|
result.postcode | string |
Address postcode |
placeOfBirth
|
result.placeOfBirth | string |
Place of birth |
vehicleClass
|
result.vehicleClass | string |
Driver license vehicle class |
restrictions
|
result.restrictions | string |
Driver license restrictions |
endorsement
|
result.endorsement | string |
Driver license endorsement |
optionalData
|
result.optionalData | string |
Extra unspecific data included in the document |
optionalData2
|
result.optionalData2 | string |
Extra unspecific data included in the document |
documentType
|
result.documentType | string |
Type of document: P=Passport, D=Driver's License, I=Identity Card, V=Visa, R=Residence Card, O=Other |
documentSide
|
result.documentSide | string |
Side of the document: FRONT, BACK or BIODATA |
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
Document issuer subregion/state. (e.g. California) |
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
Document issuer subregion/state abbreviation. (e.g. CA) |
issuerOrg_full
|
result.issuerOrg_full | string |
Document issued country. (e.g. United States) |
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
Document issued country code in ISO2. (e.g. US) |
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
Document issued country code in ISO3. (e.g. USA) |
nationality_full
|
result.nationality_full | string |
Document holder nationality. (e.g. United States) |
nationality_iso2
|
result.nationality_iso2 | string |
Document holder nationality in ISO2. (e.g. US) |
nationality_iso3
|
result.nationality_iso3 | string |
Document holder nationality in ISO3. (e.g. USA) |
internalId
|
result.internalId | string |
Used to identify the unique document ID under ID Analyzer system, same type of document should have the same ID. |
documentNumber
|
confidence.documentNumber | float |
confidence level of documentNumber |
firstName
|
confidence.firstName | float |
confidence level of firstName |
lastName
|
confidence.lastName | float |
confidence level of Last name /Family name |
middleName
|
confidence.middleName | float |
confidence level of Middle Name(s) |
dob_month
|
confidence.dob_month | float |
confidence level of dob_month |
dob_day
|
confidence.dob_day | float |
confidence level of dob_day |
dob_year
|
confidence.dob_year | float |
confidence level of dob_year |
issued_month
|
confidence.issued_month | float |
confidence level of issued_month |
issued_day
|
confidence.issued_day | float |
confidence level of issued_day |
issued_year
|
confidence.issued_year | float |
confidence level of issued_year |
expiry_month
|
confidence.expiry_month | float |
confidence level of expiry_month |
expiry_day
|
confidence.expiry_day | float |
confidence level of expiry_day |
expiry_year
|
confidence.expiry_year | float |
confidence level of expiry_year |
sex
|
confidence.sex | float |
confidence level of sex |
height
|
confidence.height | float |
confidence level of height |
weight
|
confidence.weight | float |
confidence level of weight |
address1
|
confidence.address1 | float |
confidence level of address1 |
address2
|
confidence.address2 | float |
confidence level of address2 |
postcode
|
confidence.postcode | float |
confidence level of postcode |
vehicleClass
|
confidence.vehicleClass | float |
confidence level of vehicleClass |
restrictions
|
confidence.restrictions | float |
confidence level of restrictions |
endorsement
|
confidence.endorsement | float |
confidence level of endorsement |
eyeColor
|
confidence.eyeColor | float |
confidence level of eyeColor |
age
|
confidence.age | float |
confidence level of age |
dob
|
confidence.dob | float |
confidence level of dob |
daysToExpiry
|
confidence.daysToExpiry | float |
confidence level of daysToExpiry |
expiry
|
confidence.expiry | float |
confidence level of expiry |
issued
|
confidence.issued | float |
confidence level of issued |
daysFromIssue
|
confidence.daysFromIssue | float |
confidence level of daysFromIssue |
fullName
|
confidence.fullName | float |
confidence level of fullName |
isIdentical
|
face.isIdentical | boolean |
Biometric verification passed or failed |
confidence
|
face.confidence | string |
Value between 0 to 1 on how similar the two faces are, 1 being identical. |
error
|
face.error | integer |
Error Code |
error_message
|
face.error_message | string |
Error message. Example: Could not find face data within facial image |
passed
|
verification.passed | boolean |
If document has passed all verifications, will return true. If document has failed at least one verification type, will return false. |
face
|
verification.result.face | boolean |
If biometric verification is enabled, whether similarity confidence score is above set threshold. |
notexpired
|
verification.result.notexpired | boolean |
Whether the document has not yet expired. |
name
|
verification.result.name | boolean |
Whether supplied name matched with the name parsed from ID. |
dob
|
verification.result.dob | boolean |
Whether supplied birthday matched with the birthday parsed from ID. |
documentNumber
|
verification.result.documentNumber | boolean |
Whether supplied document number matched with document number parsed from ID. |
postcode
|
verification.result.postcode | boolean |
Whether supplied postcode matched with the postcode parsed from ID. |
address
|
verification.result.address | boolean |
Whether supplied address matched with the address parsed from ID. |
checkdigit
|
verification.result.checkdigit | boolean |
If the type of document has a check digit/soundex algorithm, whether the check digits are valid. |
age
|
verification.result.age | boolean |
Whether document holder is within the set age range. |
cccode
|
verification.result.cccode | boolean |
If the type of document has Chinese commercial code (CC code) implementation, whether the CC codes are valid. |
score
|
authentication.score | float |
The score will be a float between 0 to 1. Valid documents will have a score closer to 1 while fake or edited documents will have a score closer to 0. It is your discretion to decide the boundary, a good starting point would be rejecting score less than 0.5 |
passed
|
authentication.breakdown.data_visibility.passed | boolean | |
passed
|
authentication.breakdown.image_quality.passed | boolean | |
passed
|
authentication.breakdown.feature_referencing.passed | boolean | |
passed
|
authentication.breakdown.exif_check.passed | boolean | |
code
|
authentication.breakdown.exif_check.code | integer | |
reason
|
authentication.breakdown.exif_check.reason | string | |
severity
|
authentication.breakdown.exif_check.severity | string | |
passed
|
authentication.breakdown.publicity_check.passed | boolean | |
code
|
authentication.breakdown.publicity_check.code | integer | |
reason
|
authentication.breakdown.publicity_check.reason | string | |
severity
|
authentication.breakdown.publicity_check.severity | string | |
passed
|
authentication.breakdown.text_analysis.passed | boolean | |
passed
|
authentication.breakdown.biometric_analysis.passed | boolean | |
passed
|
authentication.breakdown.security_feature_check.passed | boolean | |
code
|
authentication.breakdown.security_feature_check.code | integer | |
reason
|
authentication.breakdown.security_feature_check.reason | string | |
severity
|
authentication.breakdown.security_feature_check.severity | string | |
passed
|
authentication.breakdown.recapture_check.passed | boolean | |
code
|
authentication.breakdown.recapture_check.code | integer | |
reason
|
authentication.breakdown.recapture_check.reason | string | |
severity
|
authentication.breakdown.recapture_check.severity | string | |
warning
|
authentication.warning | array of string |
Array of string containing warning messages about validity of the document. |
aml
|
aml | array of object |
Array containing list of AML matches, returns an empty array if no match was found. For specific details refer to AML API Reference. |
entity
|
aml.entity | string |
person or legalentity |
fullname
|
aml.fullname | array of string |
Person or legal entity name(s) |
firstname
|
aml.firstname | array of string |
Person first name(s) |
lastname
|
aml.lastname | array of string |
Person last name(s) |
middlename
|
aml.middlename | array of string |
Person middle name(s) |
alias
|
aml.alias | array of string |
Alternative or foreign name(s) of the entity |
dob
|
aml.dob | array of string |
Peron's birthday, could come in YYYY, YYYY-MM, or YYYY-MM-DD formats. |
address
|
aml.address | array of string |
Address or residing country of the entity |
nationality
|
aml.nationality | array of string |
Country or nationality of the entity |
birthplace
|
aml.birthplace | array of string |
Peron's birth place |
gender
|
aml.gender | array of string |
Peron's gender: M or F |
documentnumber
|
aml.documentnumber | array of object |
A list of documents associated with the entity. |
id
|
aml.documentnumber.id | string |
Document number |
id_formatted
|
aml.documentnumber.id_formatted | string |
Alphanumeric document number |
country
|
aml.documentnumber.country | string |
ISO2 country code |
type
|
aml.documentnumber.type | string |
P = Passport number, I = ID number, D = Driving license number, O = Other/Unknown document type |
program
|
aml.program | array of string |
Sanction program(s) |
note
|
aml.note | array of string |
Additional note for the entity |
time
|
aml.time | string |
UTC TZ timestamp when entity was added to the source list or last updated |
status
|
aml.status | string |
Position/title of the entity or current status of the sanction |
source
|
aml.source | array of string |
A list of official source URL(s) |
database
|
aml.database | string |
ID Analyzer AML database code |
schema
|
aml.schema | string | |
document_url
|
contract.document_url | string |
URL to generated document |
error
|
contract.error | string |
In case the contract failed to generate, this field will contain reason such as "Invalid contract template ID". |
vaultid
|
vaultid | string |
Unique identifier to the vault entry if vault_save is enabled. |
matchrate
|
matchrate | float |
The ratio of fields successfully recognized by the API, a low ratio would indicate the document image is too blurry. |
output
|
output | string |
If outputimage is set to true and outputmode is url, this field will include an URL (or an array of URLs for dualside scan) pointing to the cropped document image. The link is only guaranteed to live for 600 seconds, and will be removed any time after. |
outputface
|
outputface | string |
If outputface is set to true and outputmode is url, this field will include an URL pointing to the cropped face image. The link is only guaranteed to live for 600 seconds, and will be removed any time after. |
cropped
|
cropped | string |
If outputimage is set to true and outputmode is base64, this field will include a base64-encoded image (or an array of base64-encoded images for dualside scan) of cropped document in JPEG format |
croppedface
|
croppedface | string |
If outputface is set to true and outputmode is base64, this field will include a base64-encoded image of cropped face region of the document in JPEG format |
executionTime
|
executionTime | float |
Time taken for the API operation in seconds. |
responseID
|
responseID | string |
A unique identifier to identify the request/response. |
quota
|
quota | integer |
Remaining API quota, resets at beginning of each month for free or yearly subscriber, or at start of each billing cycle for monthly subscriber. If you have a subscription plan, your monthly quota will be used before your credit. |
credit
|
credit | integer |
Remaining test credit for your account. If you have a subscription plan, your monthly quota will be used before your credit. |
You can create a verification session for every user requiring identity verification.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your web portal. |
type
|
type | integer |
0: Iframe Module ,1: Mobile Module, 2: Redirection Module, 3: Live Mobile Module |
|
companyname
|
companyname | True | string |
Your company or product name. |
callbackurl
|
callbackurl | string |
Webhook/Callback URL to receive verification result. |
|
biometric
|
biometric | integer |
Ask user to take a selfie photo or selfie video for face verification. |
|
biometric_threshold
|
biometric_threshold | float |
Specify the minimum score to pass facial biometric verification |
|
authenticate_minscore
|
authenticate_minscore | float |
Document must meet minimum authenticity score to pass validation. Set 0 to disable validity/authenticity check. |
|
authenticate_module
|
authenticate_module | integer |
Specify module used for validating the document. |
|
maxattempt
|
maxattempt | integer |
The number of maximum fail attempts for each verification request. |
|
successredir
|
successredir | string |
Browser will be redirected to this URL when identity verification succeeds. |
|
failredir
|
failredir | string |
Browser will be redirected to this URL when identity verification failed. |
|
customid
|
customid | string |
It is useful for identifying your user within your database. This value will be stored under docupass_customid under Vault. |
|
reusable
|
reusable | boolean |
Enabling this parameter will allow multiple users to verify their identity through the same URL, a new DocuPass reference code will be generated for each user automatically. |
|
phoneverification
|
phoneverification | boolean |
Whether to ask user to enter a phone number for verification, DocuPass supports both mobile or landline number verification. (Subscriber Only) |
|
documenttype
|
documenttype | string |
User must upload a specific type of document. For example "PD" would accept both passport and drivers license. |
|
documentcountry
|
documentcountry | string |
ISO ALPHA-2 Country Code. |
|
documentregion
|
documentregion | string |
State/Region full name or abbreviation. |
|
dualsidecheck
|
dualsidecheck | boolean |
Check if the names, document number and document type matches between the front and the back of the document when performing dual-side scan. If any information mismatches error 14 will be thrown. |
|
verify_expiry
|
verify_expiry | boolean |
Only accept document that has not expired |
|
verify_documentno
|
verify_documentno | string |
Document number requiring verification. |
|
verify_name
|
verify_name | string |
Full name including first name and last name requiring verification. |
|
verify_dob
|
verify_dob | string |
Date of birth requiring verification, in YYYY/MM/DD format. |
|
verify_age
|
verify_age | string |
Age range, example: 18-40 |
|
verify_address
|
verify_address | string |
Full address requiring verification. |
|
verify_postcode
|
verify_postcode | string |
Full postcode requiring verification. |
|
verify_phone
|
verify_phone | string |
Full phone number requiring verification. |
|
vault_save
|
vault_save | boolean |
Save user documents and parsed information into vault. |
|
return_documentimage
|
return_documentimage | boolean |
Return document image uploaded by user in the callback request. |
|
return_faceimage
|
return_faceimage | boolean |
Return face image uploaded by user in the callback request. |
|
return_type
|
return_type | integer |
Specify the type of image being returned, either base64-encoded image content or an URL to the image. (URL to image will be kept for only 7 days) |
|
welcomemessage
|
welcomemessage | string |
Replace generic greeting message on the first page with your customized text (max 1,000 characters) |
|
nobranding
|
nobranding | boolean |
Hide branding logo on all DocuPass pages. (Subscriber Only) |
|
logo
|
logo | string |
Custom branding logo. (Subscriber Only) |
|
customhtmlurl
|
customhtmlurl | string |
Use your own HTML page and CSS for DocuPass. (Subscriber Only) |
|
language
|
language | string |
DocuPass automatically detects user device language and displays corresponding language. |
|
expiry
|
expiry | integer |
Number of seconds before DocuPass session expires. Upon expiry, user will not be able to continue with the current session, a failed callback will also be sent. |
|
qr_color
|
qr_color | string |
Color of the QR Code Foreground. (Only for Live Mobile and Standard Mobile) |
|
qr_bgcolor
|
qr_bgcolor | string |
Color of the QR Code Background. (Only for Live Mobile and Standard Mobile) |
|
qr_size
|
qr_size | integer |
Size of QR Code(1-50). (Only for Live Mobile and Standard Mobile) |
|
qr_margin
|
qr_margin | integer |
Border thickness of QR Code(1-50). (Only for Live Mobile and Standard Mobile) |
Returns
Name | Path | Type | Description |
---|---|---|---|
reference
|
reference | string |
A unique reference code for the DocuPass session. |
type
|
type | integer |
DocuPass module type created. |
customid
|
customid | string |
Custom ID used when creating DocuPass session. |
url
|
url | string |
Unique URL to DocuPass web app. Send this link to your user, or embed it into your website or mobile app to begin identity verification. |
qrcode
|
qrcode | string |
QR code image URL for your user to scan |
base_url
|
base_url | string |
You may send this link to your user and ask them to enter reference code to start verification. |
html
|
html | string |
Sample HTML that you can insert into your webpage. |
smssent
|
smssent | integer |
Contains the phone number as confirmation when SMS has been successfully sent via sms_verification_link parameter. |
expiry
|
expiry | integer |
UTC UNIX timestamp indicating when this session will expire, upon expiry, user will no longer be able to use the link and a failed callback will be sent. |
You can create a signature session where user will review and e-sign legal document without identity verification. If you want to perform both identity verification and have your user sign some document, please create an identity verification session instead.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your web portal. |
companyname
|
companyname | True | string |
Your company name will be displayed throughout verification page so that end-user knows they are submitting identity information to your company |
template_id
|
template_id | string |
Contract template ID to autofill with user data. |
|
contract_format
|
contract_format | string |
Output document format. (PDF, DOCX, HTML) |
|
callbackurl
|
callbackurl | string |
Contract file will be sent to this url. You must either enable vault_save or specify a callbackurl so that you can save the generated document. |
|
successredir
|
successredir | string |
Browser will be redirected to this URL after the document has been reviewed and signed. DocuPass reference code and customid will be appended to the end of URL |
|
customid
|
customid | string |
A custom string that will be sent back to your server's callback URL, and appended to redirection URLs set by successredir and failredir as a query string. It is useful for identifying your user within your database. This value will be stored under docupass_customid under Vault. |
|
reusable
|
reusable | boolean |
nabling this parameter will allow multiple users to review and sign documents through the same URL, a new DocuPass reference code will be generated for each user automatically. |
|
sms_contract_link
|
sms_contract_link | string |
Full international mobile number |
|
vault_save
|
vault_save | boolean |
Save generated document into vault. You must either enable vault_save or specify a callbackurl so that you can save generated document. |
|
nobranding
|
nobranding | boolean |
Hide branding logo on all DocuPass pages. |
|
customhtmlurl
|
customhtmlurl | string |
Use your own HTML page and CSS for DocuPass. Once you have made changes to the HTML and CSS you need to upload them to your own server, at the start of each session DocuPass will download the latest HTML page from your server. |
|
language
|
language | string |
DocuPass automatically detects user device language and displays corresponding language. Set this parameter to override automatic language detection.(en, fr, nl, de, es, zh-TW, zh-CN) |
|
expiry
|
expiry | integer |
Number of seconds before DocuPass session expires. Upon expiry, user will not be able to continue with the current session, a failed callback will also be sent. |
|
qr_color
|
qr_color | string |
Color of the QR Code Foreground |
|
qr_bgcolor
|
qr_bgcolor | string |
Color of the QR Code Background |
|
qr_size
|
qr_size | integer |
Size of QR Code |
|
qr_margin
|
qr_margin | integer |
Border thickness of QR Code |
Returns
Name | Path | Type | Description |
---|---|---|---|
reference
|
reference | string |
A unique reference code for the DocuPass session. |
customid
|
customid | string |
Custom ID used when creating DocuPass session. |
url
|
url | string |
Unique URL to DocuPass web app. Send this link to your user, or embed it into your website or mobile app to review and sign document. |
qrcode
|
qrcode | string |
QR code image URL for your user to scan |
base_url
|
base_url | string |
You may send this link to your user and ask them to enter reference code to sign documents. |
html_qrcode
|
html_qrcode | string |
Sample HTML to display QR Code on your webpage. |
html_iframe
|
html_iframe | string |
Sample HTML to insert iframe into your webpage. |
smssent
|
smssent | string |
Contains the phone number as confirmation when SMS has been successfully sent via sms_contract_link parameter. |
expiry
|
expiry | integer |
UTC UNIX timestamp indicating when this session will expire, upon expiry, user will no longer be able to use the link and a failed callback will be sent. |
You can delete single or multiple vault entries by making HTTP POST request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
id
|
id | True | array of string |
id |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | integer |
You can delete an image inside a vault entry by making HTTP POST request. Note that after an image is deleted, the URL to the image may still be accessible for a short-period of time due to caching.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
id
|
id | True | string |
Vault entry identifier containing the image. |
imageid
|
imageid | string |
id of the image to delete. |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | integer |
Face search allows you to search the entire vault using an image of a person. To use face search feature, you must enable face search indexing under web portal, and train your vault datasets periodically.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
image
|
image | string |
Base64-encoded image data. |
|
imageurl
|
imageurl | string |
Remote image URL. |
|
maxentry
|
maxentry | integer |
Number of matching entries to be returned, between 1 to 10. |
|
threshold
|
threshold | float |
Set minimum face similarity score required, in the range of 0 to 1. |
Returns
Name | Path | Type | Description |
---|---|---|---|
items
|
items | array of |
If matching entries are found, a list of documents with full contents will be returned similar to the list command. |
Before performing face search, you must issue a train command to train the document datasets inside your vault. You may also train your vault data through web portal. The training task is asynchronous, training time depends on the number of vault entries and images. It could take from several seconds to an hour.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | integer |
When entries are added to the vault, both Core API and DocuPass API will return a vault entry identifier named vaultid. You can use the identifier to query the content of an entry in the vault by submitting an HTTP POST request to the following endpoint.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
id
|
id | string |
Vault entry identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | integer | |
id
|
data.id | string |
Vault entry identifier |
createtime
|
data.createtime | string |
Timestamp of entry creation in UTC |
updatetime
|
data.updatetime | string |
Timestamp of last modification in UTC |
trustlevel
|
data.trustlevel | string |
This score is calculated automatically if authentication is enabled. (0: Undetermined, 1: Invalid document, 2: Suspicious, 3: Valid) |
trustnote
|
data.trustnote | string |
Warnings associated with document validity. |
docupass_reference
|
data.docupass_reference | string |
Reference code to DocuPass session |
docupass_success
|
data.docupass_success | string |
0 or 1, whether the DocuPass verification succeeded or failed. |
docupass_failedreason
|
data.docupass_failedreason | string |
If DocuPass verification has failed, the reason why it failed. |
docupass_customid
|
data.docupass_customid | string |
customid passed when creating DocuPass verification. |
documentNumber
|
data.documentNumber | string |
The unique identifier of the document (Passport No./Driver License No. etc) |
documentNumber_formatted
|
data.documentNumber_formatted | string |
Automatically generated string of documentNumber without any symbols, this field is useful for filtering results. |
personalNumber
|
data.personalNumber | string |
A secondary identifier number on the document |
firstName
|
data.firstName | string |
First name / Given name |
middleName
|
data.middleName | string |
Middle name(s) |
lastName
|
data.lastName | string |
Last name / Family name |
fullName
|
data.fullName | string |
Full name (Updating other name fields will not update fullName) |
firstName_local
|
data.firstName_local | string |
First name in local language |
middleName_local
|
data.middleName_local | string |
Middle name in local language |
lastName_local
|
data.lastName_local | string |
Last name in local language |
fullName_local
|
data.fullName_local | string |
Full name in local language |
dob
|
data.dob | string |
Date of birth |
issued
|
data.issued | string |
Issue date |
expiry
|
data.expiry | string |
Expiry date |
sex
|
data.sex | string |
M: Male, F: Female, X: Unspecified |
height
|
data.height | string |
Height of person |
weight
|
data.weight | string |
Weight of person |
hairColor
|
data.hairColor | string |
Hair color |
eyeColor
|
data.eyeColor | string |
Eye color |
address1
|
data.address1 | string |
Address line 1 |
address2
|
data.address2 | string |
Address line 2 |
postcode
|
data.postcode | string |
Address postcode |
placeOfBirth
|
data.placeOfBirth | string |
Place of birth |
documentType
|
data.documentType | string |
P: Passport, D: Driver's License, I: Identity Card, V: Visa, R: Residence Card, O: Other |
documentName
|
data.documentName | string |
Name of document |
vehicleClass
|
data.vehicleClass | string |
Class of vehicles on driver's license |
restrictions
|
data.restrictions | string |
Driving restrictions |
endorsement
|
data.endorsement | string |
Driver license endorsement |
email
|
data.email | string |
User email address |
mobile
|
data.mobile | string |
User mobile phone number |
landline
|
data.landline | string |
User landline phone number |
issueAuthority
|
data.issueAuthority | string |
Issue authority of document |
issuerOrg_region_full
|
data.issuerOrg_region_full | string |
Document issuer subregion/state. Example: California |
issuerOrg_region_abbr
|
data.issuerOrg_region_abbr | string |
Document issuer subregion/state abbreviation. Example: CA |
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
Document issued country code in ISO2. Example: US |
nationality_iso2
|
data.nationality_iso2 | string |
Document holder nationality in ISO2. Example: US |
optionalData
|
data.optionalData | string |
Extra unspecific data included in the document |
optionalData2
|
data.optionalData2 | string |
Extra unspecific data included in the document |
customdata1
|
data.customdata1 | string |
5 custom strings that can be used to add custom memo to the entry |
customdata2
|
data.customdata2 | string |
5 custom strings that can be used to add custom memo to the entry |
customdata3
|
data.customdata3 | string |
5 custom strings that can be used to add custom memo to the entry |
customdata4
|
data.customdata4 | string |
5 custom strings that can be used to add custom memo to the entry |
customdata5
|
data.customdata5 | string |
5 custom strings that can be used to add custom memo to the entry |
block
|
data.block | string |
Set this parameter to block the same document from being submitted to Core API or DocuPass. |
contract
|
data.contract | string |
Link to contract or legal documents generated/signed using Core API or DocuPass |
image
|
data.image | array of object |
Contains a list of images associated with the entry. |
id
|
data.image.id | string |
Image identifier |
type
|
data.image.type | string |
0 for document and 1 for person |
hash
|
data.image.hash | string |
MD5 hash of image |
url
|
data.image.url | string |
URL to the image |
createtime
|
data.image.createtime | string |
Time image was uploaded in UTC |
To list all the entries stored inside the vault or search for entries with specific values, send an HTTP POST request to the following endpoint.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
orderby
|
orderby | string |
Name of the field used to order the result. |
|
sort
|
sort | string |
ASC to sort results in ascending order, DESC to sort in descending order. |
|
limit
|
limit | integer |
Number of vault entries to return. (1 to 100) |
|
offset
|
offset | integer |
Return list starting at a specific entry, for example, when limit=10, to access the third page of the results, use offset=20 |
|
filter
|
filter | array of string |
filter |
Returns
Name | Path | Type | Description |
---|---|---|---|
limit
|
limit | integer |
Current limit |
offset
|
offset | integer |
Current offset |
nextoffset
|
nextoffset | integer |
Offset value for the next set of data. If the current set of data is the final set of data, this field will not be returned. |
total
|
total | integer |
Total number of entries found. |
items
|
items | array of |
An array of entries found and their full content, identical to the contents returned by GET method. |
AML API allows you to search ID Analyzer global AML database for sanctions, PEPs and wanted criminals using either a name, document number or both. You may further filter the results with birthday and nationality.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your web portal. |
name
|
name | string |
Person or organization's name or alias in any language. |
|
documentnumber
|
documentnumber | string |
Person's passport number, national ID number or driving license number etc. |
|
entity
|
entity | string |
person: Person; legalentity: Company or Organization |
|
country
|
country | string |
Return only entities with matching country/nationality or no country information. |
|
dob
|
dob | string |
Return only entities with matching birthday or no birthday information. |
|
database
|
database | string |
Specify the source databases to perform AML check, if left blank, all source databases will be checked. Separate each database code with comma, for example: un_sc,us_ofac. For full list of source databases and corresponding code visit AML API Overview. |
Returns
Name | Path | Type | Description |
---|---|---|---|
aml
|
items | array of object |
Array containing list of AML matches, returns an empty array if no match was found. For specific details refer to AML API Reference. |
entity
|
items.entity | string |
person or legalentity |
fullname
|
items.fullname | array of string |
Person or legal entity name(s) |
firstname
|
items.firstname | array of string |
Person first name(s) |
lastname
|
items.lastname | array of string |
Person last name(s) |
middlename
|
items.middlename | array of string |
Person middle name(s) |
alias
|
items.alias | array of string |
Alternative or foreign name(s) of the entity |
dob
|
items.dob | array of string |
Peron's birthday, could come in YYYY, YYYY-MM, or YYYY-MM-DD formats. |
address
|
items.address | array of string |
Address or residing country of the entity |
nationality
|
items.nationality | array of string |
Country or nationality of the entity |
birthplace
|
items.birthplace | array of string |
Peron's birth place |
gender
|
items.gender | array of string |
Peron's gender: M or F |
documentnumber
|
items.documentnumber | array of object |
A list of documents associated with the entity. |
id
|
items.documentnumber.id | string |
Document number |
id_formatted
|
items.documentnumber.id_formatted | string |
Alphanumeric document number |
country
|
items.documentnumber.country | string |
ISO2 country code |
type
|
items.documentnumber.type | string |
P = Passport number, I = ID number, D = Driving license number, O = Other/Unknown document type |
program
|
items.program | array of string |
Sanction program(s) |
note
|
items.note | array of string |
Additional note for the entity |
time
|
items.time | string |
UTC TZ timestamp when entity was added to the source list or last updated |
status
|
items.status | string |
Position/title of the entity or current status of the sanction |
source
|
items.source | array of string |
A list of official source URL(s) |
database
|
items.database | string |
ID Analyzer AML database code |
schema
|
items.schema | string |
Check whether vault training is still ongoing or has completed.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
Returns
Name | Path | Type | Description |
---|---|---|---|
status
|
status | string |
nottrained: Never trained, notstarted: Training is not running, running: Training is currently running, succeeded: Training succeeded, failed: Training failed |
startTime
|
startTime | string |
Time when last training was started in UTC. |
statusChangeTime
|
statusChangeTime | string |
Time for last status change in UTC. |
lastSuccessTime
|
lastSuccessTime | string |
Time for last successful training in UTC. |
error
|
error | string |
Error message associated with failed training status. |
You can update the value of a single field or values of multiple fields in a vault entry by making HTTP POST request.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your Web Portal. |
id
|
id | True | string |
Vault entry identifier. |
address1
|
address1 | string |
Address line 1. |
|
address2
|
address2 | string |
Address line 2. |
|
block
|
block | string |
Set this parameter to block the same document from being submitted to Core API or DocuPass. 0: No block 1: Block document number 2: Block firstname/lastname 3: Block both document number and firstname/lastname. |
|
customdata1
|
customdata1 | string |
5 custom strings that can be used to add custom memo to the entry. |
|
customdata2
|
customdata2 | string |
5 custom strings that can be used to add custom memo to the entry. |
|
customdata3
|
customdata3 | string |
5 custom strings that can be used to add custom memo to the entry. |
|
customdata4
|
customdata4 | string |
5 custom strings that can be used to add custom memo to the entry. |
|
customdata5
|
customdata5 | string |
5 custom strings that can be used to add custom memo to the entry. |
|
dob
|
dob | string |
Date of birth (YYYY-MM-DD). |
|
documentName
|
documentName | string |
Name of document. |
|
documentNumber
|
documentNumber | string |
The unique identifier of the document (Passport No./Driver License No. etc) |
|
documentType
|
documentType | string |
P: Passport D: Driver's License I: Identity Card V: Visa R: Residence Card O: Other |
|
docupass_customid
|
docupass_customid | string |
customid passed when creating DocuPass verification. |
|
docupass_failedreason
|
docupass_failedreason | string |
If DocuPass verification has failed, the reason why it failed. |
|
docupass_reference
|
docupass_reference | string |
Reference code to DocuPass session. |
|
docupass_success
|
docupass_success | string |
0 or 1, whether the DocuPass verification succeeded or failed. |
|
email
|
string |
User email address. |
||
expiry
|
expiry | string |
Expiry date (YYYY-MM-DD) |
|
eyeColor
|
eyeColor | string |
Eye color. |
|
firstName
|
firstName | string |
First name / Given name |
|
firstName_local
|
firstName_local | string |
First name in local language. |
|
fullName
|
fullName | string |
Full name (Updating other name fields will not update fullName) |
|
fullName_local
|
fullName_local | string |
First name in local language. |
|
hairColor
|
hairColor | string |
Hair color. |
|
height
|
height | string |
Height of person. |
|
issueAuthority
|
issueAuthority | string |
Issue authority of document. |
|
issued
|
issued | string |
Issue date (YYYY-MM-DD) |
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
Document issued country code in ISO2. Example: US |
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
Document issuer subregion/state abbreviation. Example: CA |
|
issuerOrg_region_full
|
issuerOrg_region_full | string |
Document issuer subregion/state. Example: California |
|
landline
|
landline | string |
User landline phone number. |
|
lastName
|
lastName | string |
Last name / Family name. |
|
lastName_local
|
lastName_local | string |
Last name in local language. |
|
middleName
|
middleName | string |
Middle name(s). |
|
middleName_local
|
middleName_local | string |
Middle name in local language. |
|
mobile
|
mobile | string |
User mobile phone number. |
|
nationality_iso2
|
nationality_iso2 | string |
Document holder nationality in ISO2. Example: US |
|
optionalData
|
optionalData | string |
Extra unspecific data included in the document. |
|
optionalData2
|
optionalData2 | string |
Extra unspecific data included in the document. |
|
personalNumber
|
personalNumber | string |
A secondary identifier number on the document. |
|
placeOfBirth
|
placeOfBirth | string |
Place of birth. |
|
postcode
|
postcode | string |
Address postcode. |
|
restrictions
|
restrictions | string |
Driving restrictions. |
|
sex
|
sex | string |
M: Male F: Female X: Unspecified |
|
trustlevel
|
trustlevel | string |
0: Undetermined 1: Invalid document 2: Suspicious 3: Valid This score is calculated automatically if authentication is enabled. |
|
trustnote
|
trustnote | string | ||
vehicleClass
|
vehicleClass | string |
Class of vehicles on driver's license. |
|
weight
|
weight | string |
Weight of person. |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | integer |
To make sure the data was sent from our server.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
apikey
|
apikey | True | string |
Your private API key is available under your web portal. |
reference
|
reference | True | string |
Reference code received in POST BODY. |
hash
|
hash | True | string |
Hash received in POST BODY. |
Returns
Name | Path | Type | Description |
---|---|---|---|
success
|
success | boolean | |
reference
|
reference | string |
Reference code for the DocuPass session |