检索个人信息的结果
/aivpersonidtfy
Method : GET
URL : https://xxx.finexusgroup.com/AIV/rest/v1/aivpersonidtfy
信息
此方法将检索先前提交的特定 /aivpersonidtfy POST 请求的结果。
- 对于 同步交互模式(mode为“SYNC”),如果请求在返回响应之前被中止,可以使用此方法获取先前提交的POST请求的结果;
- 对于 异步交互模式(mode为“ASYNC”),可以使用此方法在等待特定时间间隔后获取先前提交的POST请求的结果。
- 请求
- 响应
请求参数
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
source | 是 | 字符串 | 16 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 128 | 合作伙伴 ID。 | "BSSS" |
productType | 可选 | 字符串 | 128 | 产品类型。 | "appTest" |
reference | 是 | 字符串 | 64 | 参考。 | "ID00000213132" |
apiKey | 有条件 | 字符串 | 64 | API 密钥。 | "1233214HSC" |
apiVersion | 是 | 字符串 | 8 | API 版本。 | "1.6" |
referenceId | 是 | 字符串 | 64 | 参考 ID。 | "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw" |
language | 可选 | 字符串 | 2 | 语言。 | "en","ms" |
响应代码
响应代码 | 描述 | 响应架构 |
---|---|---|
200 | 服务能够验证并允许调用者使用服务和方法。 | AIVPersonIdtfyGetResponse |
400 | 请求错误,服务无法按预期找到消息布局。 | N/A |
401 | 未经授权的访问 - 无法验证源系统。 | N/A |
405 | 禁止访问 - 源系统未被授权执行操作。 | N/A |
响应参数
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
status | 是 | 对象 | 状态。 | 参阅下文说明 | |
payload | 可选 | 对象 | 身份证件真实性的结果。 | 参阅下文说明 |
对象:status
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
sourceInfo | 是 | 对象 | 源信息。 | 参阅下文说明 | |
status | 是 | 字符串 | 16 | 状态。 | "SUCCESS", "FAIL", "QUEUED" |
errorList | 是 | 对象 | 错误列表。 | 参阅下文说明 |
对象:sourceInfo
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
source | 是 | 字符串 | 16 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 128 | 合作伙伴 ID。 | "BSSS" |
productType | 可选 | 字符串 | 128 | 合作伙伴类型。 | "appTest" |
reference | 是 | 字符串 | 64 | 参考。 | "ID00000213132" |
apiVersion | 是 | 字符串 | 8 | API 版本。 | "1.6" |
apiKey | 有条件 | 字符串 | 64 | API 密钥。 | "1233214HSC" |
userId | 可选 | 字符串 | 32 | 用户 ID。 | "mkchan" |
userToken | 可选 | 字符串 | 64 | 用户令牌。 | "APPOKJSID8J1234" |
对象:errorList
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
msgCode | 是 | 字符串 | 8 | 消息代码。 | |
msgText | 是 | 字符串 | 128 | 消息文本。 |
对象:payload
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
status | 是 | 对象 | 状态。 | 参阅下文说明 | |
payload | 是 | 对象 | 来自真实性检查的信息。 | 参阅下文说明 |
对象:status
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
sourceInfo | 是 | 对象 | 源信息。 | 参阅下文说明 | |
status | 是 | 字符串 | 16 | 状态。 | "SUCCESS", "FAIL", "QUEUED" |
errorList | 是 | 对象 | 错误列表。 | 参阅下文说明 |
对象:sourceInfo
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
source | 是 | 字符串 | 16 | 来源。 | "FNXCRDS" |
partnerId | 是 | 字符串 | 128 | 合作伙伴 ID。 | "BSSS" |
productType | 可选 | 字符串 | 128 | 合作伙伴类型。 | "appTest" |
reference | 是 | 字符串 | 64 | 参考。 | "ID00000213132" |
apiVersion | 是 | 字符串 | 8 | API 版本。 | "1.6" |
apiKey | 有条件 | 字符串 | 64 | API 密钥。 | "1233214HSC" |
userId | 可选 | 字符串 | 32 | 用户 ID。 | "mkchan" |
userToken | 可选 | 字符串 | 64 | 用户令牌。 | "APPOKJSID8J1234" |
对象:errorList
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
msgCode | 是 | 字符串 | 8 | 消息代码。 | |
msgText | 是 | 字符串 | 128 | 消息文本。 |
对象:payload
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
landmark | 是 | 对象 | 地标。 | 参阅下文说明 | |
aivRefId | 是 | 字符串 | 64 | AIV 参考 ID。 | "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw" |
idType | 可选 | 字符串 | 32 | ID 类型。 | "MYKAD", "护照" |
extractedData | 可选 | 对象 | 提取的数据。 | 参阅下文说明 | |
possibleFraud | 是 | 字符串 | 1 | 可能的欺诈。 | "t","f" |
qualityOfIdImage | 是 | 字符串 | 1 | 身份证图像的质量。 | "t","f" |
insufficientLandmarkDetection | 是 | 字符串 | 1 | 不足的地标检测。 | "t","f" |
recommendation | 是 | 对象 | 建议。 | 参阅下文说明 |
对象:landmark
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
landmarkResult | 是 | 对象 | 地标结果。 | 参阅下文说明 | |
landmarkDetails | 是 | 对象 | 地标详情。 | 参阅下文说明 |
对象:landmarkResult
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
totalNo | 是 | 字符串 (数值) | 4 | 定义的地标总数。 | "10" |
matchedNo | 是 | 字符串 (数值) | 4 | 匹配的地标数量。 | "0" |
threshold | 是 | 字符串 (数值) | 4 | 匹配阈值的数量。 | "4" |
authenticityFlg | 是 | 字符串 | 1 | 真实性标志。 | "F","T" |
对象:landmarkDetails(对于 MyKad)
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
citizenFlg | 是 | 字符串 | 1 | 公民标志。 | "T","F" |
icPlateMatch | 是 | 字符串 | 1 | 身份证板匹配。 | "T","F" |
myKadLogoMatch | 是 | 字符串 | 1 | Mykad 徽标匹配。 | "T","F" |
myFlagMatch | 是 | 字符串 | 1 | 马来西亚国旗匹配。 | "T","F" |
ghostMatch | 是 | 字符串 | 1 | 肖像图匹配。 | "T","F" |
coatOfArmsMatch | 是 | 字符串 | 1 | 纹章徽标匹配。 | "T","F" |
TnGLogoMatch | 是 | 字符串 | 1 | TnG 徽标匹配。 | "T","F" |
chipLogoMatch | 是 | 字符串 | 1 | 芯片徽标匹配。 | "T","F" |
ketuaPengarahTextFound | 是 | 字符串 | 1 | 找到 Ketua Pengarah 文本。 | "T","F" |
genderMatch | 是 | 字符串 | 1 | 性别匹配。 | "T","F" |
validBirthYear | 是 | 字符串 | 1 | 有效的出生年份。 | "T","F" |
对象:landmarkDetails(对于护照)
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
documentTypeMatch | 是 | 字符串 | 1 | 文档类型匹配。 | "T","F" |
issuingStateCodeMatch | 是 | 字符串 | 1 | 签发国家代码匹配。 | "T","F" |
passportNoMatch | 是 | 字符串 | 1 | 护照号码匹配。 | "T","F" |
expiredDocument | 是 | 字符串 | 1 | 过期的文件。 | "T","F" |
validMrz | 是 | 字符串 | 1 | 有效的机读区。 | "T","F" |
primaryNameMatch | 可选 | 字符串 | 1 | 主要名称匹配。 | "T","F" |
secondaryNameMatch | 可选 | 字符串 | 1 | 次要名称匹配。 | "T","F" |
dateOfBirthMatch | 可选 | 字符串 | 1 | 出生日期匹配。 | "T","F" |
dateOfExpiryMatch | 可选 | 字符串 | 1 | 过期日期匹配。 | "T","F" |
对象:extractedData(对于 MyKad)
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
myKadNo | 是 | 字符串 | 32 | MyKad 号码。 | "890221-58-9666" |
fullName | 是 | 字符串 | 128 | 全名。 | "John Smith" |
address | 是 | 对象 | 地址。 | 参阅下文说明 | |
gender | 是 | 字符串 | 1 | 性别。 | "M","F" |
placeOfBirth | 是 | 字符串 | 256 | 出生地点。 | "Kuala Lumpur" |
holderImage | 是 | 对象 | MyKad 持有者的面部图像。 | 参阅下文说明 | |
muslimFlg | 是 | 字符串 | 1 | 穆斯林标志。 | "T","F" |
对象:address
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
addrLine1 | 是 | 字符串 | 256 | 地址行1。 | "5, Jalan 3" |
addrLine2 | 可选 | 字符串 | 256 | 地址行2。 | "5, Jalan 3" |
addrLine3 | 可选 | 字符串 | 256 | 地址行3。 | |
city | 是 | 字符串 | 128 | 城市。 | "Petaling Jaya" |
state | 是 | 字符串 | 16 | 州。 | "Selangor" |
country | 有条件 | 字符串 | 2 | 国家。 | "MY" |
postcode | 是 | 字符串(数字) | 16 | 邮政编码。 | "46300" |
对象:holderImage
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
contentEncoding | 是 | 字符串 | 16 | 图像的编码格式。 | "BASE64" |
contentMediaType | 是 | 字符串 | 16 | 图像数据的媒体类型。 | "jpeg" |
image | 是 | 字符串 | 整个图像数据。 | "/9j/4AAQSkZJRgABAQ" |
对象:extractedData(对于护照)
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
issuingStateName | 是 | 字符串 | 256 | 签发国家名称。 | "Malaysia" |
documentName | 是 | 字符串 | 64 | 文档名称。 | "Test" |
documentType | 是 | 字符串 | 1 | 文档类型。 | "P" |
issuingStateCode | 是 | 字符串 | 2 | 签发国家代码。 | "MY" |
passportNo | 是 | 字符串 | 16 | 护照号码。 | "A123456" |
primaryName | 可选 | 字符串 | 128 | 主要名称。 | "Smith" |
secondaryName | 可选 | 字符串 | 128 | 次要名称。 | "John" |
fullName | 可选 | 字符串 | 128 | 全名。 | "John Smith" |
nationality | 是 | 字符串 | 64 | 国籍。 | "Malaysia" |
dateOfBirth | 是 | 字符串 | 256 | 出生日期。 | "01 MAY 2000" |
holderIdNo | 是 | 字符串 | 20 | 持有人的国家身份证号码。 | "1234567890" |
gender | 是 | 字符串 | 1 | 性别。 | "M","F" |
placeOfBirth | 是 | 字符串 | 256 | 出生地点。 | "Kuala Lumpur" |
dateOfIssue | 是 | 字符串 | 16 | 签发日期。 | "01 NOV 2010" |
issuingAuthority | 是 | 字符串 | 64 | 签发机构。 | "Test" |
dateOfExpiry | 是 | 字符串 | 16 | 过期日期。 | "01 NOV 2015" |
holderPortrait | 是 | 对象 | 持有者面部的图像。 | 参阅下文说明 | |
holderMark | 可选 | 对象 | 持有者的指纹或签名图像。 | 参阅下文说明 |
对象:holderPortrait
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
contentEncoding | 是 | 字符串 | 16 | 图像的编码格式。 | "BASE64" |
contentMediaType | 是 | 字符串 | 16 | 图像数据的媒体类型。 | "jpeg" |
image | 是 | 字符串 | 整个图像数据。 | "/9j/4AAQSkZJRgABAQ" |
对象:holderMark
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
contentEncoding | 是 | 字符串 | 16 | 图像的编码格式。 | "BASE64" |
contentMediaType | 是 | 字符串 | 16 | 图像数据的媒体类型。 | "jpeg" |
image | 是 | 字符串 | 整个图像数据。 | "/9j/4AAQSkZJRgABAQ" |
对象:recommendation
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
result | 是 | 字符串 | 1 | 结果。 | "T","F" |
score | 是 | 字符串(数值型) | 4 | 分数。 | "100" |
identificationCheck | 是 | 对象 | 身份验证检查。 | 参阅下文说明 | |
threshold | 是 | 字符串(数值型) | 4 | 阈值。 | "80" |
对象:identificationCheck
字段名称 | 必填 | 类型 | 长度 | 描述 | 示例 |
---|---|---|---|---|---|
result | 是 | 字符串 | 1 | 结果。 | "T","F" |
score | 是 | 字符串(数值型) | 4 | 分数。 | "20" |
threshold | 是 | 字符串(数值型) | 4 | 阈值。 | "10" |
type | 是 | 字符串 | 128 | 类型。 | "Landmark" |
maxScore | 是 | 字符串(数值型) | 4 | 最大分数。 | "20" |
示例消息
- 请求
- 响应
/aivpersonidtfy GET 请求
curl -X GET "https://xxx.finexusgroup.com/AIV/rest/clientauth/aivpersonidtfy?source=FNXCRDS&partnerId=BSSS&productType=appTest&reference=ID00000213132&apiVersion=1.6&referenceId=272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw&apiKey=1233214HSC" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
/aivpersonidtfy GET 响应
{
"status": {
"sourceInfo": {
"reference": "ID00000213132",
"apiVersion": "1.6",
"apiKey": "1233214HSC",
"source": "FNXCARDS",
"partnerId": "BSSS",
"productType": "appTest",
"referenceId": "272391d1cc5840b2abfb7340a317e353f9eswc4nyQ0CEqw",
"language": "en"
},
"errorList": [
{
"msgText": "",
"msgCode": ""
}
],
"status": "SUCCESS"
},
"payload": {
"status": {
"sourceInfo": {
"reference": "ID00000213132",
"apiVersion": "1.6",
"apiKey": "1233214HSC",
"source": "FNXCARDS",
"partnerId": "BSSS",
"productType": "appTest",
"userId": "",
"userToken": ""
},
"errorList": [
{
"msgText": "",
"msgCode": ""
}
],
"status": "SUCCESS"
},
"payload": {
"possibleFraud": "t",
"qualityOfIdImage": "t",
"idType": "mykad",
"extractedData": {
"placeOfBirth": "",
"myKadNo": "",
"address": {
"country": "",
"addrLine3": "bl",
"city": "",
"addrLine2": ".. Jw",
"addrLine1": "JALAN",
"postcode": "",
"state": ""
},
"muslimFlag": "f",
"gender": "",
"holderImage": {
"image": "/9j/4AAQSkZJRgABAQ"
"contentMediaType": "jpeg",
"contentEncoding": "base64"
},
"fullName": ""
},
"recommendation": {
"result": "F",
"score": 70,
"identificationCheck": [
{
"result": "T",
"score": 25,
"threshold": 20,
"type": "Landmarks",
"maxScore": 25
},
{
"result": "T",
"score": 25,
"threshold": 20,
"type": "Name",
"maxScore": 25
},
{
"result": "T",
"score": 25,
"threshold": 20,
"type": "MyKadNo",
"maxScore": 25
},
{
"result": "T",
"score": 25,
"threshold": 20,
"type": "address",
"maxScore": 25
}
],
"threshold": 85
},
"insufficientLandmarkDetection": "",
"landmark": {
"landmarkDetails": {
"icPlateMatch": "f",
"chipLogoMatch": "f",
"myKadLogoMatch": "f",
"coatOfArmsMatch": "f",
"portraitMatch": "f",
"citizenFlg": "f",
"TnGLogoMatch": "f",
"myFlagMatch": "f",
"ketuaPengarahTextFound": "f"
},
"landmarkResult": {
"authenticityFlg": "F",
"matchedNo": 0,
"totalNo": 10,
"threshold": 4
}
},
"aivRefId": "205"
}
}
}