文档中心 > API类目 > 天猫国际API

tmall.hk.clearance.certification.get (获取订单清关材料实名信息)

获取订单清关材料实名信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_cert_request OrderCertRequest 可选 参数
  • └ order_id
  • Number
  • 必须
  • 12345
  • 订单编号
  • └ need_image
  • Boolean
  • 可选
  • true
  • 是否需要实名图片,如需要,且是CC的订单,会返回身份证正反面图片的加密后链接

响应参数

名称 类型 示例值 描述
data OrderCertifyResponse 返回内容数据
  • └ auth
  • Boolean
  • true
  • 是否已经实名
  • order_certify
  • OrderCertify
  • 具体实名信息
  • └ ocr_id
  • String
  • 300300123456
  • 订购人身份证号加密而成的加密串
  • └ order_id
  • Number
  • 1234578
  • 订单编号
  • └ ocr_name
  • String
  • 接口测试
  • 订购人姓名加密而成的加密串
  • └ idempotent
  • String
  • edde3435cyts4
  • 身份证的幂等号,用来标识订单实名的唯一性
  • └ phone
  • String
  • 13112345678
  • 订购人电话加密而成的加密串
  • └ cert_pic_face_side
  • String
  • https://......
  • 身份证人像面图片链接,已加密
  • └ cert_pic_emblem_side
  • String
  • https://......
  • 身份证国徽面图片链接,已加密
  • └ ocr_exp
  • String
  • 2022-02-11
  • 身份证有效期,有效期的:2022-02-11 长期有效的: “X”或者“长期”
response_message String "" 错误提示信息
succeeded Boolean true 接口是否返回成功
response_code String EXECUTE_SUCCESS 错误编码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallHkClearanceCertificationGetRequest req = new TmallHkClearanceCertificationGetRequest();
TmallHkClearanceCertificationGetRequest.OrderCertRequest obj1 = new TmallHkClearanceCertificationGetRequest.OrderCertRequest();
obj1.setOrderId(12345L);
obj1.setNeedImage(true);
req.setOrderCertRequest(obj1);
TmallHkClearanceCertificationGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tmall_hk_clearance_certification_get_response>
    <data>
        <auth>true</auth>
        <order_certify>
            <ocr_id>300300123456</ocr_id>
            <order_id>1234578</order_id>
            <ocr_name>接口测试</ocr_name>
            <idempotent>edde3435cyts4</idempotent>
            <phone>13112345678</phone>
            <cert_pic_face_side>https://......</cert_pic_face_side>
            <cert_pic_emblem_side>https://......</cert_pic_emblem_side>
            <ocr_exp>2022-02-11</ocr_exp>
        </order_certify>
    </data>
    <response_message>&quot;&quot;</response_message>
    <succeeded>true</succeeded>
    <response_code>EXECUTE_SUCCESS</response_code>
</tmall_hk_clearance_certification_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部