สร้างโปรไฟล์การลงทะเบียน

สร้างโปรไฟล์เพียงครั้งเดียว

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

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

คำขอสร้าง

ยืนยันตัวตนด้วยบัญชี MultiTEL API ที่เปิดใช้งานแล้วและที่อยู่ IP ที่ได้รับอนุญาตของบัญชีนั้น ตัวอย่างใช้ข้อมูลรับรอง HTTP Basic ที่เก็บไว้ในตัวแปรสภาพแวดล้อม โปรดตรวจสอบทั้งการตอบกลับ HTTP และฟิลด์ JSON status.code; การตอบกลับ HTTP 200 เพียงอย่างเดียวไม่ได้ยืนยันว่าสำเร็จ ค่าตัวอย่างทั้งหมดเป็นค่าสมมติ

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

{
  "identity_type": "Personal",
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "country": "US",
  "address": "1 Example Street",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}

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

ฟิลด์ของโปรไฟล์การลงทะเบียน
ฟิลด์	ความจำเป็นและรูปแบบ
`identity_type`	จำเป็น ใช้ค่าที่ตรงกันทุกประการคือ Personal หรือ Business; การตรวจสอบความถูกต้องแบบมีเงื่อนไขขึ้นอยู่กับการใช้ตัวพิมพ์ใหญ่-เล็ก
`first_name, last_name`	จำเป็น แต่ละฟิลด์ยาวได้ไม่เกิน 64 อักขระ สำหรับธุรกิจ โปรดระบุรายละเอียดของผู้แทนตามที่ประเทศที่เลือกกำหนด
`phone_number`	ค่าหมายเลขโทรศัพท์ที่เป็นตัวเลข จำเป็น ความยาวอย่างน้อยแปดอักขระ หมายเลขสากลที่เป็นตัวเลขล้วนพร้อมรหัสประเทศเหมาะสำหรับการตรวจสอบนี้; นี่คือหมายเลขสำหรับติดต่อ ไม่ใช่การซื้อหมายเลข
`city, postal_code, address`	จำเป็น แต่ละฟิลด์ยาวได้ไม่เกิน 64 อักขระ
`country`	รหัส ISO ของประเทศตามที่อยู่ จำเป็น โดยเลือกจากแค็ตตาล็อกการลงทะเบียน บริการจะแปลงรหัสนี้เป็นระเบียนประเทศฝั่งผู้ให้บริการเครือข่าย
`signature`	ข้อมูลลายเซ็น จำเป็น พอร์ทัลปัจจุบันส่งไบต์ของภาพ PNG ที่เข้ารหัส Base64 โดยไม่มีคำนำหน้า data:image/png;base64, โปรดรับลายเซ็นของผู้ใช้ปลายทางผ่านเวิร์กโฟลว์ที่ได้รับอนุญาตของคุณ; ค่าตัวยึดตำแหน่งที่ไม่ว่างเปล่าไม่ถือเป็นลายเซ็นที่มีความหมาย
`nationality`	จำเป็นสำหรับ Personal ในรูปแบบรหัส ISO ของประเทศ ห้ามใช้ UUID ของประเทศแทน
`company_name, incorporation_country`	จำเป็นสำหรับ Business ชื่อบริษัทยาวได้ไม่เกิน 64 อักขระ; incorporation_country เป็นรหัส ISO ของประเทศ
`email`	อีเมลติดต่อของผู้ใช้ปลายทาง ไม่บังคับ ยาวได้ไม่เกิน 254 อักขระ อีเมลที่ละไว้หรือว่างเปล่าจะไม่รับช่วงอีเมลของบัญชีหลักมาใช้
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	ไม่บังคับในตัวจัดการนี้ แต่ประเทศ/ผู้ให้บริการเครือข่ายที่เลือกอาจกำหนดให้ต้องระบุบางฟิลด์ โปรดใส่ข้อมูลในรูปแบบที่การลงทะเบียนนั้นกำหนด การเรียก API โดยตรงจะไม่ใช้การปรับมาตรฐานทุกอย่างที่พอร์ทัลทำให้โดยอัตโนมัติ

ตัวจัดการ v3 แบบเรียกตรงนี้กำหนดให้ต้องมีฟิลด์ที่อยู่และจะสร้างที่อยู่ขึ้นมา อย่าสันนิษฐานว่าตัวเลือกเลื่อนการระบุที่อยู่ของพอร์ทัลจะใช้ได้ผ่านตัวจัดการนี้

เก็บรักษาตัวระบุทั้งสามรายการ

ตัวอย่างต่อไปนี้แสดงเฉพาะฟิลด์การตอบกลับบางส่วน; การตอบกลับจริงยังมีข้อมูลโปรไฟล์ที่ส่งไปและข้อมูลลายเซ็นด้วย โปรดจัดการการตอบกลับทั้งหมดเป็นข้อมูลส่วนตัว

{
  "status": {
    "code": 200,
    "msg": "Success Create Registration Detail."
  },
  "response": {
    "uuid": "11111111111111111111111111111111",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "country_iso": "US",
    "email": "end-user@example.com"
  }
}

response.uuid ใช้ระบุโปรไฟล์ในระบบภายใน ใช้ค่านี้กับ get_document ในการตอบกลับของ documents และ get_document ตัวระบุโปรไฟล์เดียวกันนี้จะใช้ชื่อว่า id.
response.identity_id ใช้ระบุข้อมูลตัวตนสำหรับใช้ในภายหลังกับหลักฐานยืนยันตัวตน และเอกสารประกอบ.
response.address_id ใช้ระบุที่อยู่ที่สร้างขึ้น โปรดเก็บค่านี้แยกไว้ต่างหาก; UUID ของโปรไฟล์ในระบบภายในไม่ใช่ ID ที่อยู่ ความเข้ากันได้ของการแนบหลักฐานที่อยู่ในภายหลังสำหรับโปรไฟล์ที่สร้างใหม่ยังอยู่ระหว่างการตรวจทาน

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

ขั้นสูง: แนบหลักฐานที่อัปโหลดไว้ล่วงหน้าระหว่างการสร้าง

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

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

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

ความล้มเหลวและการสร้างที่ไม่สมบูรณ์

รหัส API 400 ครอบคลุมความล้มเหลวในการตรวจสอบความถูกต้องของฟิลด์ ความล้มเหลวในการสร้างฝั่งผู้ให้บริการเครือข่าย และความล้มเหลวในการบันทึกในระบบภายใน ข้อผิดพลาดจากการตรวจสอบความถูกต้องอาจปรากฏเป็นรายการที่ใช้ชื่อฟิลด์เป็นคีย์ใน response รหัส 500 ใช้สำหรับประเทศที่ลงทะเบียนซึ่งไม่พร้อมใช้งาน/ไม่ถูกต้อง และรหัส 404 ใช้สำหรับการอ้างอิงที่อัปโหลดไว้ล่วงหน้าซึ่งหายไปหรือหมดอายุ โปรดอ่าน status.msg ควบคู่กับรหัสด้วย

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