Thay thế thông tin có thể chỉnh sửa của hồ sơ
Cập nhật hồ sơ đăng ký hiện có thuộc tài khoản bằng UUID cục bộ lấy từ create_document hoặc documents. Thao tác này thay đổi dữ liệu của tài khoản và dữ liệu phía nhà mạng. Thao tác không thay đổi loại danh tính Personal/Business đã lưu và không phải là yêu cầu PATCH chỉ cập nhật một phần các trường.
Yêu cầu cập nhật
Xác thực bằng tài khoản MultiTEL API đã được kích hoạt từ một địa chỉ IP được phép. Các ví dụ sử dụng thông tin xác thực trong biến môi trường và dữ liệu giả định. Hãy đọc cả status.code và status.msg trong JSON cùng với phản hồi HTTP.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @registration-profile-update.json \
"https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"{
"first_name": "Example",
"last_name": "Person",
"phone_number": "12025550123",
"email": "end-user@example.com",
"city": "Example City",
"postal_code": "00000",
"address": "1 Example Street",
"country": "US",
"nationality": "US",
"signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
"id_number": "",
"personal_tax_id": "",
"birth_date": "",
"description": "Example profile",
"company_name": "",
"company_reg_number": "",
"incorporation_country": "",
"vat_id": "",
"address_description": ""
}Ví dụ minh họa một hồ sơ Personal; hãy thay bằng đầy đủ thông tin mong muốn và chữ ký được cho phép của người dùng cuối. Không gửi chữ ký giữ chỗ hoặc giá trị trống để giữ nguyên dữ liệu. Hỗ trợ dữ liệu đầu vào dạng JSON và dạng mã hóa biểu mẫu.
| Các trường | Cách xử lý |
|---|---|
| first_name, last_name, city, postal_code, address | Bắt buộc; mỗi trường tối đa 64 ký tự. |
| phone_number | Bắt buộc là giá trị dạng số có ít nhất tám ký tự; sử dụng các chữ số theo định dạng quốc tế, bao gồm mã quốc gia. |
| signature | Bắt buộc. Cổng thông tin cung cấp các byte PNG được mã hóa Base64, không có tiền tố URL dữ liệu. |
| country | Cung cấp mã ISO của quốc gia trong địa chỉ từ danh mục đăng ký. Bộ xử lý sẽ tra cứu mã này, mặc dù thao tác cập nhật địa chỉ đã được rà soát không thay đổi liên kết với quốc gia. |
| nationality | Bắt buộc cung cấp mã ISO quốc gia đối với hồ sơ Personal hiện có. |
| company_name, incorporation_country | Bắt buộc đối với hồ sơ Business hiện có; tên công ty tối đa 64 ký tự và quốc gia thành lập phải là mã ISO. |
| Không bắt buộc; địa chỉ thư điện tử hợp lệ có tối đa 254 ký tự. Bỏ qua trường này để giữ nguyên địa chỉ liên hệ đã lưu; gửi giá trị trống để xóa địa chỉ đó trong dữ liệu cục bộ. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Gửi các giá trị hiện tại mà bạn muốn lưu. Giá trị bị bỏ qua mặc định là trống và có thể ghi đè lên các giá trị đã lưu. |
Quy định đăng ký riêng của từng quốc gia có thể yêu cầu thông tin hoặc định dạng bổ sung. Không dựng lại toàn bộ dữ liệu cập nhật chỉ từ get_document vì phản hồi giới hạn của thao tác này không bao gồm các trường chọn quốc gia, email và mã định danh thực thể. Hãy giữ lại dữ liệu nguồn mà bạn được phép sử dụng hoặc dùng trình chỉnh sửa hồ sơ trên cổng thông tin.
Nâng cao: thêm tài liệu chứng minh đã tải lên
Các mảng không bắt buộc identity_encryptfiles và address_encryptfiles chấp nhận các tham chiếu còn hiệu lực, thuộc tài khoản, từ create_encrypt_files. Hãy sử dụng đúng loại thực thể của tệp đã tải lên và gửi trước khi tham chiếu hết hạn. Mỗi tệp được đính kèm trong một yêu cầu chứng minh riêng, ngay cả khi nhiều tệp có cùng loại chứng minh. Với tài liệu chứng minh danh tính gồm nhiều tệp, hãy dùng quy trình đính kèm tài liệu chứng minh ở bước sau với một mảng duy nhất.
Nếu bằng chứng địa chỉ sau này bị từ chối đối với một địa chỉ mới tạo, đừng thay thế bằng UUID hồ sơ hay tạo lại danh tính nhiều lần. Hãy dừng lại và kiểm tra hồ sơ trên cổng thông tin hoặc với bộ phận hỗ trợ. Đường dẫn đọc lại/tra cứu bằng chứng địa chỉ vẫn là một hạn chế đang được xem xét.
Phản hồi thành công và thất bại kiểu cũ
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Mã thành công thông thường của điểm cuối này là chuỗi success, thay vì số 200. Lỗi thông thường ở phía nhà mạng hoặc cục bộ có thể sử dụng chuỗi error. Mã số 400 áp dụng cho các trường không hợp lệ hoặc lỗi tài liệu chứng minh, 404 cho hồ sơ không tồn tại hoặc tham chiếu tệp đã tải lên không hợp lệ, và 500 cho nội dung yêu cầu trống hoặc quốc gia không tra cứu được. Hãy đọc thông báo và mọi mục kết quả kiểm tra tính hợp lệ; không coi riêng HTTP 200 là thành công.
Giới hạn cập nhật hiện tại và cách khôi phục
Thông báo thành công không bảo đảm rằng mọi trường phía nhà mạng đều đã thay đổi. Mã đã được rà soát có thể lưu hồ sơ cục bộ sau khi cập nhật địa chỉ phía nhà mạng thất bại. Thao tác cập nhật danh tính phía nhà mạng không bao gồm email. Chưa xác nhận rằng luồng xử lý này thực hiện thay đổi quốc gia của địa chỉ hoặc đồng bộ mô tả địa chỉ. Nếu cần các thay đổi đó, hãy kiểm tra kết quả trên cổng thông tin và liên hệ bộ phận hỗ trợ thay vì cho rằng thông tin đăng ký phía nhà mạng đã được cập nhật.
Việc cập nhật không phải là một giao dịch nguyên tử duy nhất: thay đổi danh tính và đính kèm tài liệu chứng minh có thể đã được thực hiện trước khi xảy ra lỗi ở bước sau. Không có khóa bảo đảm tính lũy đẳng được cung cấp. Sau một phản hồi không rõ kết quả, hãy kiểm tra hồ sơ và các tệp đính kèm trước khi thử lại; gửi lại tài liệu chứng minh có thể tạo bản trùng lặp. Cập nhật hồ sơ không đồng nghĩa với việc tài liệu chứng minh được phê duyệt hoặc số điện thoại được kích hoạt.