tencentcloud-sdk-nodejs-intl-en
Version:
1,583 lines (1,354 loc) • 266 kB
JavaScript
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const AbstractModel = require("../../common/abstract_model");
/**
* GetLivenessResult response structure.
* @class
*/
class GetLivenessResultResponse extends AbstractModel {
constructor(){
super();
/**
* The final verification result.
* @type {string || null}
*/
this.Result = null;
/**
* The description of the final verification result.
* @type {string || null}
*/
this.Description = null;
/**
* The face screenshot.
* @type {FileInfo || null}
*/
this.BestFrame = null;
/**
* The video for the detection.
* @type {FileInfo || null}
*/
this.Video = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.Description = 'Description' in params ? params.Description : null;
if (params.BestFrame) {
let obj = new FileInfo();
obj.deserialize(params.BestFrame)
this.BestFrame = obj;
}
if (params.Video) {
let obj = new FileInfo();
obj.deserialize(params.Video)
this.Video = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Suspected attack detail
* @class
*/
class AttackRiskDetail extends AbstractModel {
constructor(){
super();
/**
* <p>Suspected attack trace type, specific type as follows:<br>SuspectedSpoofingAttack: Rephotography attack<br>SuspectedSynthesisImage: Suspected synthesized image<br>SuspectedSynthesisVideo: Suspected synthesized video<br>SuspectedAnomalyAttack: Facial features suspected of not being real<br>SuspectedAdversarialAttack: Suspected adversarial sample attack<br>SuspectedBlackIndustry: Suspected black industry batch template attack<br>SuspectedWatermark: Suspected watermark</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Type = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Type = 'Type' in params ? params.Type : null;
}
}
/**
* Additional details
* @class
*/
class ExtraInfo extends AbstractModel {
constructor(){
super();
/**
* Full details of the hit template; return solely the template with the maximum similarity.
* @type {Array.<RetrievalLivenessExtraInfo> || null}
*/
this.RetrievalLivenessExtraInfo = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
if (params.RetrievalLivenessExtraInfo) {
this.RetrievalLivenessExtraInfo = new Array();
for (let z in params.RetrievalLivenessExtraInfo) {
let obj = new RetrievalLivenessExtraInfo();
obj.deserialize(params.RetrievalLivenessExtraInfo[z]);
this.RetrievalLivenessExtraInfo.push(obj);
}
}
}
}
/**
* CheckIdNameDate response structure.
* @class
*/
class CheckIdNameDateResponse extends AbstractModel {
constructor(){
super();
/**
* Verification result code. Billing is as follows.
-Result code for charges
Same.
-1: Inconsistent.
-Result code with no charge
-2: Invalid ID number (incorrect length or check digit).
-3: Invalid name (incorrect length or format).
-4: Invalid validity period (incorrect length, format, etc.).
-5: Invalid identity information.
-6: Document library service exception.
-7: No ID card record found in the document library.
-8: Authentication attempts exceeded the daily limit. Retry the next day.
* @type {string || null}
*/
this.Result = null;
/**
* Business result description.
* @type {string || null}
*/
this.Description = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.Description = 'Description' in params ? params.Description : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* IdCardVerification request structure.
* @class
*/
class IdCardVerificationRequest extends AbstractModel {
constructor(){
super();
/**
* Identity card number.
* @type {string || null}
*/
this.IdCard = null;
/**
* Name
* @type {string || null}
*/
this.Name = null;
/**
* Sensitive data encryption info.
-Users with encryption requirements for incoming information (name, identity card number) can use this parameter. For details, please click the left-side link.
* @type {Encryption || null}
*/
this.Encryption = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IdCard = 'IdCard' in params ? params.IdCard : null;
this.Name = 'Name' in params ? params.Name : null;
if (params.Encryption) {
let obj = new Encryption();
obj.deserialize(params.Encryption)
this.Encryption = obj;
}
}
}
/**
* ImageRecognitionV2 response structure.
* @class
*/
class ImageRecognitionV2Response extends AbstractModel {
constructor(){
super();
/**
* <p>Similarity. - Value ranges from 0.00 to 100.00. - Recommend at least 70 to be determined as the same person. You can self-adjust the threshold based on specific scenarios (the pass rate for false matches at threshold 70 is 0.01%).</p>
* @type {number || null}
*/
this.Sim = null;
/**
* <p>Business error code.</p><ul><li>Success case returns Success.</li><li>For error conditions, refer to the FailedOperation part in the error code list below.</li></ul>
* @type {string || null}
*/
this.Result = null;
/**
* <p>Business result description.</p>
* @type {string || null}
*/
this.Description = null;
/**
* <p>Custom description field in the API call.</p>
* @type {string || null}
*/
this.Extra = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Sim = 'Sim' in params ? params.Sim : null;
this.Result = 'Result' in params ? params.Result : null;
this.Description = 'Description' in params ? params.Description : null;
this.Extra = 'Extra' in params ? params.Extra : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* GetWebVerificationResultIntl response structure.
* @class
*/
class GetWebVerificationResultIntlResponse extends AbstractModel {
constructor(){
super();
/**
* The final result of this verification. `0` indicates that the person is the same as that in the photo.
For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Selfie Verification (Mobile HTML5) Error Codes</a>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {number || null}
*/
this.ErrorCode = null;
/**
* The description of the final verification result.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ErrorMsg = null;
/**
* The detailed verification result list of this process. Retries are allowed, so a verification process may have several entries of results.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<VerificationDetail> || null}
*/
this.VerificationDetailList = null;
/**
* The Base64-encoded string of the video collected from the video stream. Retries are allowed, and this field returns only the data collected in the last verification. If no video is collected, null is returned.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.VideoBase64 = null;
/**
* The Base64-encoded string of the best face screenshot collected from the video stream. Retries are allowed, and this field returns only the data collected in the last verification. If no best face screenshot is collected, null is returned.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.BestFrameBase64 = null;
/**
* Card recognize result
* @type {Array.<OCRResult> || null}
*/
this.OCRResult = null;
/**
* The passthrough parameter of the business, max 1,000 characters, which will be returned in GetWebVerificationResultIntl.
* @type {string || null}
*/
this.Extra = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ErrorCode = 'ErrorCode' in params ? params.ErrorCode : null;
this.ErrorMsg = 'ErrorMsg' in params ? params.ErrorMsg : null;
if (params.VerificationDetailList) {
this.VerificationDetailList = new Array();
for (let z in params.VerificationDetailList) {
let obj = new VerificationDetail();
obj.deserialize(params.VerificationDetailList[z]);
this.VerificationDetailList.push(obj);
}
}
this.VideoBase64 = 'VideoBase64' in params ? params.VideoBase64 : null;
this.BestFrameBase64 = 'BestFrameBase64' in params ? params.BestFrameBase64 : null;
if (params.OCRResult) {
this.OCRResult = new Array();
for (let z in params.OCRResult) {
let obj = new OCRResult();
obj.deserialize(params.OCRResult[z]);
this.OCRResult.push(obj);
}
}
this.Extra = 'Extra' in params ? params.Extra : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* MobileStatus request structure.
* @class
*/
class MobileStatusRequest extends AbstractModel {
constructor(){
super();
/**
* Mobile number.
* @type {string || null}
*/
this.Mobile = null;
/**
* Sensitive data encryption info.
-Users with encryption requirements for incoming information (mobile number) can use this parameter. For details, please click the left-side link.
* @type {Encryption || null}
*/
this.Encryption = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Mobile = 'Mobile' in params ? params.Mobile : null;
if (params.Encryption) {
let obj = new Encryption();
obj.deserialize(params.Encryption)
this.Encryption = obj;
}
}
}
/**
* The content of a single license in the license information
* @class
*/
class OCRResult extends AbstractModel {
constructor(){
super();
/**
* <p>Whether the identity authentication or OCR process is successful.</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {boolean || null}
*/
this.IsPass = null;
/**
* <p>Base64 of the front side ID image</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CardImageBase64 = null;
/**
* <p>ID card recognition result</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {CardInfo || null}
*/
this.CardInfo = null;
/**
* <p>Document recognition result (when CheckMode value is 4, return the OriginalCardInfo field; other scenarios return the current field)</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {NormalCardInfo || null}
*/
this.NormalCardInfo = null;
/**
* <p>Request id</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RequestId = null;
/**
* <p>Base64 of the cropped ID image</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CardCutImageBase64 = null;
/**
* <p>Base64 of the cropped image of the back side of the ID</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CardBackCutImageBase64 = null;
/**
* <p>Alarm code</p><p>Enumeration value:</p><ul><li>9101: Alarm for incomplete document border</li><li>9102: Alarm for document photocopy</li><li>9103: Alarm for rephotographing</li><li>9104: PS alarm</li><li>9107: Reflective alarm</li><li>9108: Blurry alarm</li><li>9109: Alarm capability not enabled</li></ul>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<number> || null}
*/
this.WarnCardInfos = null;
/**
* <p>Original document recognition information (the current field will be returned when CheckMode value is 4)</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.OriginalCardInfo = null;
/**
* <p>Document portrait matting</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.HeadImageBase64 = null;
/**
* <p>Base64 of the back side ID image</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CardBackImageBase64 = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.IsPass = 'IsPass' in params ? params.IsPass : null;
this.CardImageBase64 = 'CardImageBase64' in params ? params.CardImageBase64 : null;
if (params.CardInfo) {
let obj = new CardInfo();
obj.deserialize(params.CardInfo)
this.CardInfo = obj;
}
if (params.NormalCardInfo) {
let obj = new NormalCardInfo();
obj.deserialize(params.NormalCardInfo)
this.NormalCardInfo = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
this.CardCutImageBase64 = 'CardCutImageBase64' in params ? params.CardCutImageBase64 : null;
this.CardBackCutImageBase64 = 'CardBackCutImageBase64' in params ? params.CardBackCutImageBase64 : null;
this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
this.OriginalCardInfo = 'OriginalCardInfo' in params ? params.OriginalCardInfo : null;
this.HeadImageBase64 = 'HeadImageBase64' in params ? params.HeadImageBase64 : null;
this.CardBackImageBase64 = 'CardBackImageBase64' in params ? params.CardBackImageBase64 : null;
}
}
/**
* Bangladesh ID card
* @class
*/
class BangladeshIDCard extends AbstractModel {
constructor(){
super();
/**
* Last name.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LastName = null;
/**
* First name.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.FirstName = null;
/**
* License number.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LicenseNumber = null;
/**
* Age.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Age = null;
/**
* Birthday.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Birthday = null;
/**
* Issued country.
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IssuedCountry = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.LastName = 'LastName' in params ? params.LastName : null;
this.FirstName = 'FirstName' in params ? params.FirstName : null;
this.LicenseNumber = 'LicenseNumber' in params ? params.LicenseNumber : null;
this.Age = 'Age' in params ? params.Age : null;
this.Birthday = 'Birthday' in params ? params.Birthday : null;
this.IssuedCountry = 'IssuedCountry' in params ? params.IssuedCountry : null;
}
}
/**
* LivenessCompare response structure.
* @class
*/
class LivenessCompareResponse extends AbstractModel {
constructor(){
super();
/**
* The best screenshot of the video after successful verification. The photo is Base64-encoded and in JPG format.
* @type {string || null}
*/
this.BestFrameBase64 = null;
/**
* Similarity. Value range: [0.00, 100.00]. As a recommendation, when the similarity is greater than or equal to 70, it can be determined that the two faces are of the same person. You can adjust the threshold according to your specific scenario (the FAR at the threshold of 70 is 0.1%, and FAR at the threshold of 80 is 0.01%).
* @type {number || null}
*/
this.Sim = null;
/**
* Service error code. `Success` will be returned for success. For error information, please see the `FailedOperation` section in the error code list below.
* @type {string || null}
*/
this.Result = null;
/**
* Service result description.
* @type {string || null}
*/
this.Description = null;
/**
* Best screenshot list.
Returned only when multiple best screenshots are configured to be returned.
* @type {Array.<string> || null}
*/
this.BestFrameList = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.BestFrameBase64 = 'BestFrameBase64' in params ? params.BestFrameBase64 : null;
this.Sim = 'Sim' in params ? params.Sim : null;
this.Result = 'Result' in params ? params.Result : null;
this.Description = 'Description' in params ? params.Description : null;
this.BestFrameList = 'BestFrameList' in params ? params.BestFrameList : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Philippines SSSID Card
* @class
*/
class PhilippinesSSSID extends AbstractModel {
constructor(){
super();
/**
* License number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LicenseNumber = null;
/**
* Full name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.FullName = null;
/**
* Birthday
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Birthday = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.LicenseNumber = 'LicenseNumber' in params ? params.LicenseNumber : null;
this.FullName = 'FullName' in params ? params.FullName : null;
this.Birthday = 'Birthday' in params ? params.Birthday : null;
}
}
/**
* DetectAIFakeFaces request structure.
* @class
*/
class DetectAIFakeFacesRequest extends AbstractModel {
constructor(){
super();
/**
* <p>Import the face image or facial video to be detected (currently only single face detection is supported) in base64 encoding. If your scenario involves both video and image, we recommend using video for detection. For better detection results, please note the following input data limits and suggestions:</p><ul><li><p>base64 value of the image:<br>Recommend an overall image resolution of 480x640, with the face size no less than 100x100, captured by the mobile front camera.<br>The size of the base64-encoded image data should not exceed 3M, with a maximum of 10M. Only jpg and png formats are supported.<br>Please use the standard base64 encoding method (with = padding). Refer to RFC4648 for the coding specification.</p></li><li><p>base64 value of the video:<br>The size after base64 encoding should be within 8M, with a maximum of 10M. Supported formats include mp4, avi, and flv, captured by the mobile front camera.<br>Video duration is recommended to be 2–5s, with a maximum of 20s.<br>Video resolution is recommended at 480x640 (maximum support for 720p), with a frame rate between 25fps and 30fps.<br>Please use the standard base64 encoding method (with = padding). Refer to RFC4648 for the coding specification.</p></li></ul><p>If you do not use Encryption for secure transmission, this field is a required parameter.</p>
* @type {string || null}
*/
this.FaceInput = null;
/**
* <p>Passed in type.</p><ul><li>Value ranges from 1 to 2:<br>1: Passed in image type.<br>2: Passed in video type.<br>Other: Return error code InvalidParameter.</li></ul><p>If you do not use Encryption for encrypting transmission, this field is mandatory.</p>
* @type {number || null}
*/
this.FaceInputType = null;
/**
* <p>Whether to encrypt the entire request information.</p><ul><li>Supported encryption algorithms: AES-256-CBC, SM4-GCM.</li><li>The user with encryption requirements can use this parameter. For details, please click the left-side link.</li></ul>
* @type {Encryption || null}
*/
this.Encryption = null;
/**
* <p>Encrypted ciphertext.</p><ul><li>The data format before encryption is as follows: {"FaceInput":"AAAAA","FaceInputType":1}.</li></ul>
* @type {string || null}
*/
this.EncryptedBody = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FaceInput = 'FaceInput' in params ? params.FaceInput : null;
this.FaceInputType = 'FaceInputType' in params ? params.FaceInputType : null;
if (params.Encryption) {
let obj = new Encryption();
obj.deserialize(params.Encryption)
this.Encryption = obj;
}
this.EncryptedBody = 'EncryptedBody' in params ? params.EncryptedBody : null;
}
}
/**
* Indonesia ID card.
* @class
*/
class IndonesiaIDCard extends AbstractModel {
constructor(){
super();
/**
* License number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.NIK = null;
/**
* Name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Nama = null;
/**
* Birth place/Birthday
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.TempatTglLahir = null;
/**
* Gender
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.JenisKelamin = null;
/**
* Blood type
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.GolDarah = null;
/**
* Address
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Alamat = null;
/**
* Street
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RTRW = null;
/**
* Village
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.KelDesa = null;
/**
* Region
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Kecamatan = null;
/**
* Religious beliefs
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Agama = null;
/**
* Marital status
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.StatusPerkawinan = null;
/**
* Job
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Perkerjaan = null;
/**
* Nationality
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.KewargaNegaraan = null;
/**
* ID card validity period
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.BerlakuHingga = null;
/**
* Date of issue
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IssuedDate = null;
/**
* Province
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Provinsi = null;
/**
* City
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Kota = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NIK = 'NIK' in params ? params.NIK : null;
this.Nama = 'Nama' in params ? params.Nama : null;
this.TempatTglLahir = 'TempatTglLahir' in params ? params.TempatTglLahir : null;
this.JenisKelamin = 'JenisKelamin' in params ? params.JenisKelamin : null;
this.GolDarah = 'GolDarah' in params ? params.GolDarah : null;
this.Alamat = 'Alamat' in params ? params.Alamat : null;
this.RTRW = 'RTRW' in params ? params.RTRW : null;
this.KelDesa = 'KelDesa' in params ? params.KelDesa : null;
this.Kecamatan = 'Kecamatan' in params ? params.Kecamatan : null;
this.Agama = 'Agama' in params ? params.Agama : null;
this.StatusPerkawinan = 'StatusPerkawinan' in params ? params.StatusPerkawinan : null;
this.Perkerjaan = 'Perkerjaan' in params ? params.Perkerjaan : null;
this.KewargaNegaraan = 'KewargaNegaraan' in params ? params.KewargaNegaraan : null;
this.BerlakuHingga = 'BerlakuHingga' in params ? params.BerlakuHingga : null;
this.IssuedDate = 'IssuedDate' in params ? params.IssuedDate : null;
this.Provinsi = 'Provinsi' in params ? params.Provinsi : null;
this.Kota = 'Kota' in params ? params.Kota : null;
}
}
/**
* Singapore ID Card
* @class
*/
class SingaporeIDCard extends AbstractModel {
constructor(){
super();
/**
* Chinese name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ChName = null;
/**
* Chinese name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ChineseName = null;
/**
* English name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.EnName = null;
/**
* English name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.FullName = null;
/**
* License number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ID = null;
/**
* License number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LicenseNumber = null;
/**
* Gender
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Sex = null;
/**
* Country of birth
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CountryOfBirth = null;
/**
* Nationality
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Nationality = null;
/**
* Birthday
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Birthday = null;
/**
* Address (on the back)
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Address = null;
/**
* Race (on the back)
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Race = null;
/**
* NRIC number (on the back)
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.NRICCode = null;
/**
* Post number (on the front)
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.PostCode = null;
/**
* Date of expiry (on the back)
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.DateOfExpiration = null;
/**
* Date of issue (on the back)
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.DateOfIssue = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ChName = 'ChName' in params ? params.ChName : null;
this.ChineseName = 'ChineseName' in params ? params.ChineseName : null;
this.EnName = 'EnName' in params ? params.EnName : null;
this.FullName = 'FullName' in params ? params.FullName : null;
this.ID = 'ID' in params ? params.ID : null;
this.LicenseNumber = 'LicenseNumber' in params ? params.LicenseNumber : null;
this.Sex = 'Sex' in params ? params.Sex : null;
this.CountryOfBirth = 'CountryOfBirth' in params ? params.CountryOfBirth : null;
this.Nationality = 'Nationality' in params ? params.Nationality : null;
this.Birthday = 'Birthday' in params ? params.Birthday : null;
this.Address = 'Address' in params ? params.Address : null;
this.Race = 'Race' in params ? params.Race : null;
this.NRICCode = 'NRICCode' in params ? params.NRICCode : null;
this.PostCode = 'PostCode' in params ? params.PostCode : null;
this.DateOfExpiration = 'DateOfExpiration' in params ? params.DateOfExpiration : null;
this.DateOfIssue = 'DateOfIssue' in params ? params.DateOfIssue : null;
}
}
/**
* Macao (China) IDCard
* @class
*/
class MacaoIDCard extends AbstractModel {
constructor(){
super();
/**
* First name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.FirstName = null;
/**
* Last name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LastName = null;
/**
* Birthday
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Birthday = null;
/**
* Expiration date
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ExpirationDate = null;
/**
* License number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LicenseNumber = null;
/**
* Sex
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Sex = null;
/**
* Age
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Age = null;
/**
* Issued country
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IssuedCountry = null;
/**
* MRZ1 on card
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Field1 = null;
/**
* MRZ2 on card
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Field2 = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.FirstName = 'FirstName' in params ? params.FirstName : null;
this.LastName = 'LastName' in params ? params.LastName : null;
this.Birthday = 'Birthday' in params ? params.Birthday : null;
this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
this.LicenseNumber = 'LicenseNumber' in params ? params.LicenseNumber : null;
this.Sex = 'Sex' in params ? params.Sex : null;
this.Age = 'Age' in params ? params.Age : null;
this.IssuedCountry = 'IssuedCountry' in params ? params.IssuedCountry : null;
this.Field1 = 'Field1' in params ? params.Field1 : null;
this.Field2 = 'Field2' in params ? params.Field2 : null;
}
}
/**
* General liscense information.
* @class
*/
class GeneralCard extends AbstractModel {
constructor(){
super();
/**
* License number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LicenseNumber = null;
/**
* Personal number, which is returned when it is a passport
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.PersonalNumber = null;
/**
* The first line of passport machine reading code
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.PassportCodeFirst = null;
/**
* The first line of passport machine reading code
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.PassportCodeSecond = null;
/**
* Date of expiry in the format of YYYY-MM-DD
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.ExpirationDate = null;
/**
* Valid date in the format of YYYY-MM-DD
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.DueDate = null;
/**
* Date of issue in the format of YYYY-MM-DD
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IssuedDate = null;
/**
* Issuing authority
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.IssuedAuthority = null;
/**
* Issuing country, which is returned following the ISO 3166 country coding specification
Note: This field may return null, indicating that no valid values can be obtained.
Example: MYS
* @type {string || null}
*/
this.IssuedCountry = null;
/**
* Full Name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.FullName = null;
/**
* First name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.FirstName = null;
/**
* Last name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.LastName = null;
/**
* Gender on the license
- M: male
- F: female
- X: other gender
Note: This field may return null, indicating that no valid values can be obtained.
Example: M
* @type {string || null}
*/
this.Sex = null;
/**
* Age. 0 indicates that no valid information is obtained.
Example: 0
* @type {string || null}
*/
this.Age = null;
/**
* Birthday
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Birthday = null;
/**
* Birth place
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.BirthPlace = null;
/**
* Nationality, which is returned following the ISO 3166 country coding specification
Note: This field may return null, indicating that no valid values can be obtained.
Example: IND
* @type {string || null}
*/
this.Nationality = null;
/**
* Registration number
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.RegistrationNumber = null;
/**
* Address
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Address || null}
*/
this.Address = null;
/**
* Localized name.
* @type {string || null}
*/
this.FullNameLocal = null;
/**
* Localization.
* @type {string || null}
*/
this.FirstNameLocal = null;
/**
* Localized surname.
* @type {string || null}
*/
this.LastNameLocal = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.LicenseNumber = 'LicenseNumber' in params ? params.LicenseNumber : null;
this.PersonalNumber = 'PersonalNumber' in params ? params.PersonalNumber : null;
this.PassportCodeFirst = 'PassportCodeFirst' in params ? params.PassportCodeFirst : null;
this.PassportCodeSecond = 'PassportCodeSecond' in params ? params.PassportCodeSecond : null;
this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
this.DueDate = 'DueDate' in params ? params.DueDate : null;
this.IssuedDate = 'IssuedDate' in params ? params.IssuedDate : null;
this.IssuedAuthority = 'IssuedAuthority' in params ? params.IssuedAuthority : null;
this.IssuedCountry = 'IssuedCountry' in params ? params.IssuedCountry : null;
this.FullName = 'FullName' in params ? params.FullName : null;
this.FirstName = 'FirstName' in params ? params.FirstName : null;
this.LastName = 'LastName' in params ? params.LastName : null;
this.Sex = 'Sex' in params ? params.Sex : null;
this.Age = 'Age' in params ? params.Age : null;
this.Birthday = 'Birthday' in params ? params.Birthday : null;
this.BirthPlace = 'BirthPlace' in params ? params.BirthPlace : null;
this.Nationality = 'Nationality' in params ? params.Nationality : null;
this.RegistrationNumber = 'RegistrationNumber' in params ? params.RegistrationNumber : null;
if (params.Address) {
let obj = new Address();
obj.deserialize(params.Address)
this.Address = obj;
}
this.FullNameLocal = 'FullNameLocal' in params ? params.FullNameLocal : null;
this.FirstNameLocal = 'FirstNameLocal' in params ? params.FirstNameLocal : null;
this.LastNameLocal = 'LastNameLocal' in params ? params.LastNameLocal : null;
}
}
/**
* Philippines UMID Card
* @class
*/
class PhilippinesUMID extends AbstractModel {
constructor(){
super();
/**
* Surname
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Surname = null;
/**
* Middle Name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.MiddleName = null;
/**
* First name
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.GivenName = null;
/**
* Gender
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Sex = null;
/**
* Birthday
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Birthday = null;
/**
* Address
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.Address = null;
/**
* CRN code
Note: This field may return null, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.CRN = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Surname = 'Surname' in params ? params.Surname : null;
this.MiddleName = 'MiddleName' in params ? params.MiddleName : null;
this.GivenName = 'GivenName' in params ? params.GivenName : null;
this.Sex = 'Sex' in params ? params.Sex : null;
this.Birthday = 'Birthday' in params ? params.Birthday : null;
this.Address = 'Address' in params ? params.Address : null;
this.CRN = 'CRN' in params ? params.CRN : null;
}
}
/**
* BankCard2EVerification response structure.
* @class
*/
class BankCard2EVerificationResponse extends AbstractModel {
constructor(){
super();
/**
* Verification result code.
-Billing result code:
'0': 'Authentication passed'.
'-1': 'Authentication failed'.
'-4': 'Cardholder information is incorrect'.
'-5': 'Cardless payment not enabled'.
'-6': 'Card confiscated'.
'-7': 'Invalid card number'.
'-8': 'No corresponding issuing bank for this card'.
'-9': 'The card is uninitialized or a Sleep Card'.
'-10': 'Cheat card, card confiscation'.
'-11': 'Reported lost'.
'-12': 'The card has expired'.
'-13': 'Restricted card'.
'-14': 'Number of password errors exceeds the limit'.
'-15': 'Issuer does not support this transaction'.
'-18': 'Card status exception or card number error'.
-Non-billing Result Code:
'-2': 'Name verification failed'.
'-3': 'Incorrect bank card number format'.
'-16': 'Verification Center Service busy'.
'-17': 'Verification attempts exceeded. Please retry the next day.'
* @type {string || null}
*/
this.Result = null;
/**
* Business result description.
* @type {string || null}
*/
this.Description = null;
/**
* The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
* @type {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Result = 'Result' in params ? params.Result : null;
this.Description = 'Description' in params ? params.Description : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* MobileStatus response structure.
* @class
*/
class MobileStatusResponse extends AbstractModel {
constructor(){
super();
/**
* Verification result code. Billing is as follows.
-Result code for charges
0: Success.
-Result code with no charge
-No results found.
-2: Invalid phone number format.
-3: Verification Center Service is busy.
-4: Authentication attempts exceeded the daily limit. Retry the next day.
* @type {string || null}
*/
this.Result = null;
/**
* Business result description.
* @type {string || null}
*/
this.Description = null;
/**
* Statu