InitCardVerifyRequest (cloudauth20190307 3.9.4 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.cloudauth20190307.models.InitCardVerifyRequest

public class InitCardVerifyRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`callbackToken` Security Token, used for anti-replay and anti-tampering checks.
`String`	`callbackUrl` The callback notification address for the authentication result, which must start with https.
`String`	`cardPageNumber` Number of card pages collected by the SDK You can input 1 or 2; input 1 to collect the front side, input 2 to collect both the front and back sides.
`String`	`cardType` Type of identification Resident Second Generation ID Card: IDENTITY_CARD This parameter is required.
`String`	`docScanMode` Enumeration of photo-taking methods (manual/auto) Take a photo: shoot Scan: scan Auto switch: auto example: shoot
`String`	`merchantBizId` A unique business identifier you define, used for subsequent troubleshooting.
`String`	`metaInfo` MetaInfo environment parameter, which needs to be obtained through the client SDK.
`String`	`model` Verification method, value: OCR_VERIFY: OCR recognition and verification mode.
`String`	`pictureSave` Whether to temporarily store the images collected by the app.
`String`	`verifyMeta` Verification type, value: Identity two elements (name + ID number): ID_2_META This parameter is required.

构造器概要

构造器
构造器和说明

InitCardVerifyRequest()

构造器
构造器和说明
`InitCardVerifyRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static InitCardVerifyRequest`	`build(Map<String,?> map)`
`String`	`getCallbackToken()`
`String`	`getCallbackUrl()`
`String`	`getCardPageNumber()`
`String`	`getCardType()`
`String`	`getDocScanMode()`
`String`	`getMerchantBizId()`
`String`	`getMetaInfo()`
`String`	`getModel()`
`String`	`getPictureSave()`
`String`	`getVerifyMeta()`
`InitCardVerifyRequest`	`setCallbackToken(String callbackToken)`
`InitCardVerifyRequest`	`setCallbackUrl(String callbackUrl)`
`InitCardVerifyRequest`	`setCardPageNumber(String cardPageNumber)`
`InitCardVerifyRequest`	`setCardType(String cardType)`
`InitCardVerifyRequest`	`setDocScanMode(String docScanMode)`
`InitCardVerifyRequest`	`setMerchantBizId(String merchantBizId)`
`InitCardVerifyRequest`	`setMetaInfo(String metaInfo)`
`InitCardVerifyRequest`	`setModel(String model)`
`InitCardVerifyRequest`	`setPictureSave(String pictureSave)`
`InitCardVerifyRequest`	`setVerifyMeta(String verifyMeta)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - callbackToken
```
@NameInMap(value="CallbackToken")
public String callbackToken
```
    Security Token, used for anti-replay and anti-tampering checks. If this parameter is passed, the CallbackToken field will be displayed in the callback address.
    example:
    NMjvQanQgplBSaEI0sL86WnQplB
  - callbackUrl
```
@NameInMap(value="CallbackUrl")
public String callbackUrl
```
    - The callback notification address for the authentication result, which must start with https.
    - The platform will call back this address after completing the authentication and automatically add the certifyId and passed fields, example: https://www.aliyun.com?certifyId=xxxx&passed=T
    - Warning The callback is triggered only when the authentication is completed. If the authentication is abandoned, interrupted abnormally, or not performed, no notification will be sent. It is recommended that when you receive the callback notification, if necessary, you can obtain detailed authentication information through the query interface.
    example:
    https://www.aliyun.com
  - cardPageNumber
```
@NameInMap(value="CardPageNumber")
public String cardPageNumber
```
    Number of card pages collected by the SDK
    - You can input 1 or 2; input 1 to collect the front side, input 2 to collect both the front and back sides.
    - If the verification type is ID period (VerifyMeta value is ID_PERIOD), you must input 2.
    This parameter is required.
    example:
    1
  - cardType
```
@NameInMap(value="CardType")
public String cardType
```
    Type of identification
    - Resident Second Generation ID Card: IDENTITY_CARD
    This parameter is required.
    example:
    IDENTITY_CARD
  - docScanMode
```
@NameInMap(value="DocScanMode")
public String docScanMode
```
    Enumeration of photo-taking methods (manual/auto)
    - Take a photo: shoot
    - Scan: scan
    - Auto switch: auto
    example:
    shoot
  - merchantBizId
```
@NameInMap(value="MerchantBizId")
public String merchantBizId
```
    A unique business identifier you define, used for subsequent troubleshooting. Supports a combination of 32 alphanumeric characters, please ensure uniqueness.
    
    This parameter is required.
    example:
    e0c34a77f5ac40a5aa5e6ed20c35****
  - metaInfo
```
@NameInMap(value="MetaInfo")
public String metaInfo
```
    MetaInfo environment parameter, which needs to be obtained through the client SDK.
    
    This parameter is required.
    example:
    {"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}
  - model
```
@NameInMap(value="Model")
public String model
```
    Verification method, value:
    - OCR_VERIFY: OCR recognition and verification mode.
    This parameter is required.
    example:
    OCR_VERIFY
  - pictureSave
```
@NameInMap(value="PictureSave")
public String pictureSave
```
    Whether to temporarily store the images collected by the app.
    - Y: Yes
    - N: No
    - If \"Yes\" is selected here, the query interface will support returning the card image information.
    This parameter is required.
    example:
    Y
  - verifyMeta
```
@NameInMap(value="VerifyMeta")
public String verifyMeta
```
    Verification type, value:
    - Identity two elements (name + ID number): ID_2_META
    This parameter is required.
    example:
    ID_2_META
- 构造器详细资料
  - InitCardVerifyRequest
```
public InitCardVerifyRequest()
```
- 方法详细资料
  - build
```
public static InitCardVerifyRequest build(Map<String,?> map)
                                   throws Exception
```
    抛出:
    
    Exception
  - setCallbackToken
```
public InitCardVerifyRequest setCallbackToken(String callbackToken)
```
  - getCallbackToken
```
public String getCallbackToken()
```
  - setCallbackUrl
```
public InitCardVerifyRequest setCallbackUrl(String callbackUrl)
```
  - getCallbackUrl
```
public String getCallbackUrl()
```
  - setCardPageNumber
```
public InitCardVerifyRequest setCardPageNumber(String cardPageNumber)
```
  - getCardPageNumber
```
public String getCardPageNumber()
```
  - setCardType
```
public InitCardVerifyRequest setCardType(String cardType)
```
  - getCardType
```
public String getCardType()
```
  - setDocScanMode
```
public InitCardVerifyRequest setDocScanMode(String docScanMode)
```
  - getDocScanMode
```
public String getDocScanMode()
```
  - setMerchantBizId
```
public InitCardVerifyRequest setMerchantBizId(String merchantBizId)
```
  - getMerchantBizId
```
public String getMerchantBizId()
```
  - setMetaInfo
```
public InitCardVerifyRequest setMetaInfo(String metaInfo)
```
  - getMetaInfo
```
public String getMetaInfo()
```
  - setModel
```
public InitCardVerifyRequest setModel(String model)
```
  - getModel
```
public String getModel()
```
  - setPictureSave
```
public InitCardVerifyRequest setPictureSave(String pictureSave)
```
  - getPictureSave
```
public String getPictureSave()
```
  - setVerifyMeta
```
public InitCardVerifyRequest setVerifyMeta(String verifyMeta)
```
  - getVerifyMeta
```
public String getVerifyMeta()
```

类 InitCardVerifyRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

callbackToken

callbackUrl

cardPageNumber

cardType

docScanMode

merchantBizId

metaInfo

model

pictureSave

verifyMeta

构造器详细资料

InitCardVerifyRequest

方法详细资料

build

setCallbackToken

getCallbackToken

setCallbackUrl

getCallbackUrl

setCardPageNumber

getCardPageNumber

setCardType

getCardType

setDocScanMode

getDocScanMode

setMerchantBizId

getMerchantBizId

setMetaInfo

getMetaInfo

setModel

getModel

setPictureSave

getPictureSave

setVerifyMeta

getVerifyMeta