首頁 > API文檔 > 實名寄遞API
是應國家法律法規要求,用户寄快件時需要進行實名登記。快遞鳥實名寄遞API,提供平台類註冊子用户的實名提交入口(包括散户,協議用户),已提交實名信息的快遞鳥用户,通過預約取件,電子面單等API提交訂單時,將同步實名信息到收件快遞員設備上,寄件時可免出示身份證(部分快遞)。一次實名,終身有效,所有快遞公司通用。提升用户寄件,快遞員攬件效率的同時減少隱私信息頻繁暴露。
支持同步實名信息的接口:
預約取件接口、電子面單接口、軌跡訂閲接口(包含收寄方信息)。支持的快遞公司:
安能快遞(ANE)、中通快遞(ZTO)、國通快遞(GTO)、韻達速遞(YD)(僅支持預約取件接口)、德邦快遞(DBL)(僅支持預約取件接口)、百世快遞(HTKY)(僅支持電子面單接口)。支持的快遞櫃:
豐巢快遞櫃(FCBOX)(僅支持預約取件接口)。適用於電商平台,ERP系統商,快遞發發等平台,提供給註冊用户實名認證功能,認證後實名寄件時免出示身份證(快遞公司陸續支持)功能包括:
(1)個人用户實名認證。
(2)申請快遞公司協議用户(即將上線)。
(3)個人用户,協議用户實名寄件。
一、 請求系統級參數説明:
參數名稱 | 類型 | 説明 | 必須要求 |
---|
RequestData | String | 應用級別參數(Json格式)。 | O |
EBusinessID | String | 商户ID。 | R |
RequestType | String | 請求指令類型:1021 | R |
DataSign | String | 數據內容簽名。 | R |
DataType | String | 請求、返回數據類型: 2-json。 | R |
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
二、應用級輸入參數(RequestData)
請求內容字段定義:
參數名稱 | 類型 | 説明 | 是否必須 |
---|
MemberID | String | 平台會員ID或ERP商家ID等 | O |
Name | String | 姓名 | R |
Gender | Int | 性別: 1-男 2-女 | O |
TypeOfId | Int | 證件類型:1-身份證 | R |
NumberOfId | String | 證件號 | R |
Contact | Array | 聯繫方式,可提交多條 [{“Mobile”:”123”,”Phone”:”123”},{“Mobile”:”1223”,”Phone”:”123”}] | R |
Province | String | 地址中的省、自治區或直轄市 | R |
City | String | 地址中的市 | R |
Address | String | 個人詳細地址 | R |
CodeOfWeixin | String | 微信號 | O |
CollectMethod | Int | 用户信息採集方式 1-身份證件識別設備 2-NFC+SAM方式 3-OCR讀取方式 | R |
ImageFront | String | 身份證正面照(圖片轉成base64字符串) | R |
ImageBack | String | 身份證反面照(圖片轉成base64字符串) | R |
ImageHand | String | 手持身份證正面照(圖片轉成base64字符串 | O |
UserType | String | 10:個人散件用户,11:個人協議用户,不填默認為10 | O |
StoreName | String | 對應的店鋪名稱,如為個人協議用户,此字段必填。 | C |
返回參數定義:
參數名稱 | 類型 | 説明 | 必須要求 |
---|
EBusinessID | String | 電商用户ID | R |
Success | Bool | 成功與否 | R |
Reason | String | 失敗原因 | O |
三、示例
{ "MemberID": "", "Name": "1234567", "Gender": "2", "TypeOfId": "1", "NumberOfId": "420211199901011234", "Contact": [{ "Mobile": "13500000000", "Phone": "" }, { "Mobile": "15817289472", "Phone": "07558651234" }], "Province": "廣東省", "City": "深圳市", "Area": "福田區", "Address": "金花路11號", "CodeOfWeixin": "", "CollectMethod": "3", "ImageFront": "Base64Z", "ImageBack": "Base64F", "ImageHand": "" }
{ "UpdateTime": "2018-02-02 13:59:02", "EBusinessID": "1261799", "Success": true }