นักพัฒนา

POST/v3/update_document/{uuid}

อัปเดตโปรไฟล์การลงทะเบียน

ส่งรายละเอียดโปรไฟล์ที่แก้ไขได้ให้ครบถ้วน และจัดการรูปแบบการตอบกลับเมื่อสำเร็จแบบเดิม

ในหน้านี้
  1. แทนที่รายละเอียดที่แก้ไขได้ของโปรไฟล์
  2. คำขออัปเดต
  3. ขั้นสูง: เพิ่มหลักฐานที่อัปโหลดไว้แล้ว
  4. การตอบกลับเมื่อสำเร็จและล้มเหลวแบบเดิม
  5. ข้อจำกัดของการอัปเดตในปัจจุบันและการกู้คืน

แทนที่รายละเอียดที่แก้ไขได้ของโปรไฟล์

อัปเดตโปรไฟล์การลงทะเบียนที่มีอยู่และเป็นของบัญชี โดยใช้ UUID ภายในระบบที่ได้จาก create_document หรือ documents การดำเนินการนี้เปลี่ยนแปลงข้อมูลของบัญชีและข้อมูลในระบบของผู้ให้บริการเครือข่ายต้นทาง แต่ไม่เปลี่ยนประเภทตัวตน Personal/Business ที่จัดเก็บไว้ และไม่ใช่ PATCH ที่อัปเดตเพียงบางฟิลด์

คำขออัปเดต

ยืนยันตัวตนด้วยบัญชี MultiTEL API ที่เปิดใช้งานแล้วจากที่อยู่ IP ที่ได้รับอนุญาต ตัวอย่างใช้ข้อมูลรับรองในตัวแปรสภาพแวดล้อมและข้อมูลสมมติ ให้อ่าน status.code และ status.msg ใน JSON ควบคู่กับการตอบกลับ 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": ""
}

ตัวอย่างแสดงโปรไฟล์ Personal ให้แทนที่ด้วยรายละเอียดที่ต้องการของผู้ใช้ปลายทางให้ครบถ้วน พร้อมลายเซ็นที่ได้รับอนุญาต อย่าส่งลายเซ็นตัวอย่างหรือค่าว่างเพื่อคงข้อมูลเดิมไว้ รองรับข้อมูลนำเข้าแบบ JSON และแบบเข้ารหัสฟอร์ม

ข้อกำหนดของฟิลด์สำหรับการอัปเดต
ฟิลด์ลักษณะการทำงาน
first_name, last_name, city, postal_code, addressจำเป็นต้องระบุ แต่ละฟิลด์ยาวได้ไม่เกิน 64 อักขระ
phone_numberจำเป็นต้องระบุค่าเป็นตัวเลขที่มีความยาวอย่างน้อยแปดอักขระ ใช้ตัวเลขในรูปแบบสากลรวมรหัสประเทศด้วย
signatureจำเป็นต้องระบุ พอร์ทัลส่งข้อมูลไบต์ PNG ที่เข้ารหัส Base64 โดยไม่มีคำนำหน้า URL ข้อมูล
countryระบุรหัส ISO ของประเทศในที่อยู่จากรายการข้อมูลการลงทะเบียน ตัวจัดการจะค้นหาประเทศจากรหัสนี้ แม้ว่าการอัปเดตที่อยู่ที่ตรวจทานแล้วจะไม่ได้เปลี่ยนความสัมพันธ์กับประเทศก็ตาม
nationalityจำเป็นต้องระบุรหัส ISO ของประเทศสำหรับโปรไฟล์ Personal ที่มีอยู่
company_name, incorporation_countryจำเป็นต้องระบุสำหรับโปรไฟล์ Business ที่มีอยู่ ชื่อบริษัทยาวได้ไม่เกิน 64 อักขระ และประเทศที่จดทะเบียนจัดตั้งต้องเป็นรหัส ISO
emailระบุหรือไม่ก็ได้ โดยต้องเป็นที่อยู่อีเมลที่ถูกต้องและยาวไม่เกิน 254 อักขระ หากไม่ส่งฟิลด์นี้ ระบบจะคงอีเมลติดต่อที่จัดเก็บไว้ หากส่งค่าว่าง ระบบจะล้างอีเมลดังกล่าวเฉพาะในระบบภายใน
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idส่งค่าปัจจุบันที่ต้องการจัดเก็บ ค่าที่ไม่ได้ส่งจะมีค่าเริ่มต้นเป็นค่าว่าง และอาจเขียนทับค่าที่จัดเก็บอยู่เดิม

กฎการลงทะเบียนเฉพาะประเทศอาจกำหนดให้ใช้ข้อมูลหรือรูปแบบเพิ่มเติม อย่าสร้างข้อมูลอัปเดตทั้งหมดขึ้นใหม่โดยอาศัยเพียง get_document เท่านั้น เนื่องจากการตอบกลับมีข้อมูลจำกัดและไม่มีตัวเลือกประเทศ email และรหัสเอนทิตี ให้เก็บข้อมูลต้นฉบับที่คุณได้รับอนุญาตให้ใช้ไว้ หรือใช้เครื่องมือแก้ไขเอกสารในพอร์ทัล

ขั้นสูง: เพิ่มหลักฐานที่อัปโหลดไว้แล้ว

อาร์เรย์ identity_encryptfiles และ address_encryptfiles ซึ่งระบุหรือไม่ก็ได้ รับการอ้างอิงที่ยังใช้งานได้และเป็นของบัญชีจาก create_encrypt_files ให้ใช้หมวดหมู่เอนทิตีให้ตรงกับไฟล์ที่อัปโหลด และส่งก่อนการอ้างอิงหมดอายุ แต่ละไฟล์จะถูกแนบในคำขอหลักฐานแยกกัน แม้หลายไฟล์จะเป็นหลักฐานประเภทเดียวกันก็ตาม สำหรับหลักฐานยืนยันตัวตนที่มีหลายไฟล์ ให้ใช้ขั้นตอน การแนบหลักฐาน ในภายหลัง โดยใช้อาร์เรย์เดียว

หากหลักฐานที่อยู่ที่ส่งในภายหลังถูกปฏิเสธสำหรับที่อยู่ที่สร้างใหม่ อย่าใช้ UUID ของโปรไฟล์แทนหรือสร้างข้อมูลตัวตนซ้ำหลายครั้ง โปรดหยุดและตรวจสอบโปรไฟล์ในพอร์ทัลหรือกับฝ่ายสนับสนุน เส้นทางการอ่านกลับ/ค้นหาหลักฐานที่อยู่ยังคงเป็นข้อจำกัดที่อยู่ระหว่างการตรวจทาน

การตอบกลับเมื่อสำเร็จและล้มเหลวแบบเดิม

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

รหัสสำเร็จตามปกติของปลายทางนี้เป็นสตริง success แทนที่จะเป็นตัวเลข 200 ความล้มเหลวตามปกติในระบบต้นทางหรือระบบภายในอาจใช้สตริง error รหัสตัวเลข 400 ครอบคลุมฟิลด์ที่ไม่ถูกต้องหรือความล้มเหลวเกี่ยวกับหลักฐาน ส่วน 404 หมายถึงไม่พบโปรไฟล์หรือการอ้างอิงไฟล์ที่อัปโหลดไม่ถูกต้อง และ 500 หมายถึงเนื้อหาคำขอว่างหรือไม่สามารถค้นหาประเทศจากรหัสได้ ให้อ่านข้อความและรายการผลการตรวจสอบความถูกต้องทั้งหมด อย่าถือว่า HTTP 200 เพียงอย่างเดียวหมายถึงสำเร็จ

ข้อจำกัดของการอัปเดตในปัจจุบันและการกู้คืน

การรายงานว่าสำเร็จไม่ได้รับประกันว่าทุกฟิลด์ในระบบต้นทางเปลี่ยนแปลงแล้ว โค้ดที่ตรวจทานแล้วสามารถบันทึกโปรไฟล์ในระบบภายในหลังจากการอัปเดตที่อยู่ในระบบต้นทางล้มเหลวได้ การอัปเดตข้อมูลตัวตนในระบบต้นทางไม่รวม email ยังไม่ได้ยืนยันว่ากระบวนการนี้เปลี่ยนประเทศของที่อยู่หรือซิงโครไนซ์คำอธิบายที่อยู่ หากต้องการการเปลี่ยนแปลงเหล่านี้ ให้ตรวจสอบผลในพอร์ทัลและติดต่อฝ่ายสนับสนุน แทนการสันนิษฐานว่าข้อมูลการลงทะเบียนในระบบต้นทางได้รับการอัปเดตแล้ว

การอัปเดตไม่ได้เป็นธุรกรรมเดียวที่สำเร็จหรือล้มเหลวพร้อมกันทั้งหมด การเปลี่ยนแปลงข้อมูลตัวตนและการแนบหลักฐานอาจเกิดขึ้นก่อนที่จะล้มเหลวในขั้นตอนถัดไป ไม่มีคีย์สำหรับป้องกันการดำเนินการซ้ำให้ใช้งาน หลังได้รับการตอบกลับที่ไม่แน่ชัด ให้ตรวจสอบโปรไฟล์และไฟล์แนบก่อนลองอีกครั้ง การส่งหลักฐานซ้ำอาจสร้างรายการซ้ำได้ การอัปเดตโปรไฟล์ไม่ได้หมายความว่าหลักฐานได้รับอนุมัติหรือหมายเลขถูกเปิดใช้งานแล้ว