Đính kèm tài liệu bổ trợ

Đính kèm tài liệu bổ trợ theo mẫu

Sử dụng một mẫu từ get_supporting_document_templates cùng một hồ sơ danh tính đã thuộc tài khoản của bạn. Tải các tệp của tài liệu lên qua create_encrypt_files bằng cách sử dụng supporting_template_id. Các tệp chứng minh danh tính hoặc địa chỉ thông thường được tải lên thuộc danh mục khác và không thể dùng để thay thế.

Tạo tài liệu bổ trợ

Sử dụng tài khoản API MultiTEL đã được kích hoạt và địa chỉ IP được phép của tài khoản đó. Các ví dụ sử dụng thông tin xác thực HTTP Basic lấy từ biến môi trường; hãy tuân theo quy ước xác thực dành cho loại tài khoản của bạn. Gửi yêu cầu qua HTTPS. Kiểm tra cả phản hồi HTTP và trường sau trong JSON: status.code; lỗi ứng dụng có thể được trả về cùng mã HTTP 200. Các ví dụ bên dưới là giả định.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

Các trường của yêu cầu
Trường	Ý nghĩa
`identity_id`	Mã định danh bắt buộc của hồ sơ danh tính liên kết với tài khoản của bạn. Yêu cầu này đính kèm tài liệu vào hồ sơ danh tính, không đính kèm trực tiếp vào địa chỉ hoặc số điện thoại.
`template_id`	Mã định danh mẫu tài liệu bổ trợ bắt buộc; sử dụng đúng mẫu đã chọn khi tải tệp bổ trợ lên. Trường dùng khi đính kèm là template_id, còn trường dùng khi tải lên là supporting_template_id.
`encrypted_file_ids`	Mảng JSON bắt buộc, không được rỗng, chứa các mã định danh tệp tải lên đã được trả về. Mỗi tệp phải thuộc tài khoản hiện tại, chưa hết hạn và thuộc danh mục supporting_documents.

Cũng chấp nhận dữ liệu biểu mẫu có nhiều trường encrypted_file_ids[] lặp lại. Không gửi dữ liệu nhị phân của tệp đến điểm cuối đính kèm này.

Tài liệu bổ trợ đã được tạo

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Kết quả này xác nhận việc tạo tài liệu bổ trợ, không xác nhận việc phê duyệt theo quy định hay kích hoạt số điện thoại. Thuật ngữ vĩnh viễn trong tài nguyên của hệ thống thượng nguồn không phải là cam kết với khách hàng về thời gian lưu trữ hoặc chính sách xóa.

Lỗi và việc thử lại

Mã API 500 biểu thị dữ liệu đầu vào bị thiếu, lỗi từ nhà mạng hoặc phản hồi không hợp lệ từ nhà mạng. Mã 404 biểu thị hồ sơ danh tính không liên kết với tài khoản, mẫu không hợp lệ, các tệp tải lên bị thiếu, đã hết hạn hoặc sai danh mục, hoặc không có tệp nào có thể sử dụng. Hãy kiểm tra status.msg; chỉ riêng mã HTTP 200 là chưa đủ.

Tải lên và đính kèm trong thời hạn hiệu lực của tham chiếu tệp được trả về. Sau khi nhận phản hồi không rõ kết quả, hãy kiểm tra các tài liệu bổ trợ của hồ sơ danh tính trong cổng thông tin trước khi thử lại. Trình xử lý này không cung cấp khóa bảo đảm việc gửi lại cùng yêu cầu không tạo thêm tác động.