# 上传收件人证件影像 ⚠️ 终端消费者身份证正反面（PII）

`POST /api/v1/shipments/identity-documents` — 需要 token · logistics:write · 写操作 · 2 点

发货与物流

上传收件人证件影像 ⚠️ 终端消费者身份证正反面（PII）。默认关闭，需显式申请开通；只透传、不落日志、不进缓存

## 请求体（JSON）

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `front_image` **必填** | string | ⚠️ 身份证正面影像（base64）。这是终端消费者的敏感个人信息，我们只透传、不落日志、不进缓存。此接口默认关闭，需显式申请。 (最长 8000000) |
| `back_image` **必填** | string | ⚠️ 身份证背面影像（base64）。同上。 (最长 8000000) |
| `shipment_ids` | array<string> | 关联的发货单号数组（选填）。 (0–100) |
| `recipient` | object | 收件人对象 { name, phone, address, country_code, state, city, postal_code }。country_code 用 AU / CN / NZ；寄澳洲、新西兰时 state / city / postal_code 必填。跨境件电话请带国际区号（如 +61…），地址请含门牌——地址不全是派送失败最常见的原因。 |
| `recipient.name` | string | 收件人姓名，写全名（快递面单上打印的就是它）。 (最长 128) |
| `recipient.phone` | string | 收件人电话。跨境件请带国际区号（如 +61…），否则清关和派送可能联系不上。 (最长 64) |
| `document_number` | string | 收件人证件号（选填），清关时核对用。 (最长 64) |

## 响应

响应信封只看 HTTP 状态码：成功是 2xx，正文 `{ data: … }`（列表另带 `page / page_size / has_more` 或 `total_count`）；失败是 4xx / 5xx，正文 `{ error: { code, message, hint, request_id, doc_url } }`。

```json
{
  "data": { … }
}
```

成功响应里没有任何给人看的文字——没有 `code / result / msg`。`error.code` 是唯一该用程序判断的字段，`message` 跟随 `Accept-Language`。

> 写操作请带 `Idempotency-Key` 头（任意唯一串，如 UUID）：网络重试不会重复下单。下单默认只建草稿，由人在 ERP 确认后生效。

## 示例

### curl

```bash
curl -X POST "https://connect.everugg.net.au/api/v1/shipments/identity-documents" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: <uuid>" \
  -d '{ "front_image": "<front_image>", "back_image": "<back_image>" }'
```

### Python

```python
import requests

r = requests.post(
    "https://connect.everugg.net.au/api/v1/shipments/identity-documents",
    headers={"Authorization": "Bearer " + TOKEN, "Idempotency-Key": str(uuid.uuid4())},
    json={
      "front_image": "<front_image>",
      "back_image": "<back_image>"
    },
)
data = r.json()
r.raise_for_status()  # 4xx/5xx: data["error"]["code"] / ["hint"]
```

### Node

```js
const res = await fetch("https://connect.everugg.net.au/api/v1/shipments/identity-documents", {
  method: "POST",
  headers: { Authorization: `Bearer ${TOKEN}`, "Content-Type": "application/json", "Idempotency-Key": crypto.randomUUID() },
  body: JSON.stringify({
    "front_image": "<front_image>",
    "back_image": "<back_image>"
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${data.error?.code}: ${data.error?.message}`)
```

### Java

```java
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://connect.everugg.net.au/api/v1/shipments/identity-documents"))
    .header("Authorization", "Bearer " + token)
    .header("Content-Type", "application/json")
    .header("Idempotency-Key", UUID.randomUUID().toString())
    .POST(HttpRequest.BodyPublishers.ofString("{ \"front_image\": \"<front_image>\", \"back_image\": \"<back_image>\" }"))
    .build();
HttpResponse<String> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());
```

---
Markdown 源: https://connect.everugg.net.au/reference/post-api-v1-shipments-identity-documents.md?lang=zh · 网页版: https://connect.everugg.net.au/reference?op=post-api-v1-shipments-identity-documents&lang=zh