Geliştiriciler

POST/v3/create_document

Kayıt profili oluşturma

Bir kimlik/adres profili oluşturun ve ayrı profil ve varlık tanımlayıcılarını saklayın.

Bu sayfada
  1. Profili bir kez oluşturun
  2. Oluşturma isteği
  3. Üç tanımlayıcının tümünü saklayın
  4. Gelişmiş: oluşturma sırasında önceden yüklenmiş kanıtları ekleme
  5. Hatalar ve kısmi oluşturma

Profili bir kez oluşturun

Bu istek, operatör kimlik ve adres kayıtlarıyla birlikte yerel bir kayıt profili oluşturur. Başlangıç olarak güncel kayıt ülkeleri, numara türleri ve gereksinimler listelerini inceleyin. Gereksinimler, kaydetmeyi planladığınız ülkeye ve numara türüne göre değişir.

Başarılı bir oluşturma yanıtı, düzenleyici onay veya numara etkinleştirme anlamına gelmez. Belge UUID'sini, kimlik kimliğini ve adres kimliğini ayrı ayrı kaydedin: farklı amaçlara hizmet ederler. Bu istek hesap verilerini değiştirir ve yalnızca doğrulama amaçlı bir işlem değildir.

Oluşturma isteği

Etkinleştirilmiş MultiTEL API hesabınız ve izin verilen IP adresiyle kimlik doğrulaması yapın. Örnekler, ortam değişkenlerinde saklanan HTTP Basic kimlik bilgilerini kullanır. Hem HTTP yanıtını hem de JSON status.code değerini kontrol edin; tek başına HTTP 200 yanıtı başarıyı kanıtlamaz. Tüm örnek değerler kurgusaldır.

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"
}

Bu JSON, gönderilmeye hazır gerçek bir kimlik değil, açıklayıcı bir Personal profilidir. Ayrıntılarını ve imzayı, seçilen kayıt kurallarının gerektirdiği son kullanıcı bilgileriyle değiştirin. Form kodlamalı girdi de desteklenir.

Kayıt profili alanları
AlanZorunluluk ve biçim
identity_typeZorunlu. Tam olarak Personal veya Business değerini kullanın; koşullu doğrulama büyük/küçük harf yazımına bağlıdır.
first_name, last_nameZorunlu, her biri en fazla 64 karakter. İşletme için, seçilen ülkenin gerektirdiği temsilci bilgilerini sağlayın.
phone_numberZorunlu sayısal telefon değeri, en az sekiz karakter. Ülke kodunu içeren, yalnızca rakamlardan oluşan uluslararası bir numara bu doğrulama için uygundur; bu bir iletişim numarasıdır, numara satın alma değildir.
city, postal_code, addressZorunlu, her biri en fazla 64 karakter.
countryZorunlu, kayıt kataloğundan alınan adres ülkesinin ISO kodu. Hizmet bunu operatör ülke kaydına çözümler.
signatureZorunlu imza verisi. Mevcut portal, Base64 PNG görüntü baytlarını data:image/png;base64, öneki olmadan sağlar. Son kullanıcı imzasını yetkili iş akışınız aracılığıyla edinin; boş olmayan bir yer tutucu anlamlı bir imza değildir.
nationalityPersonal için zorunlu, ülke ISO kodu olarak. Bunun yerine ülke UUID'si kullanmayın.
company_name, incorporation_countryBusiness için zorunlu. Şirket adı en fazla 64 karakterdir; incorporation_country bir ülke ISO kodudur.
emailİsteğe bağlı son kullanıcı iletişim e-postası, en fazla 254 karakter. Atlanan veya boş e-posta, temel hesap e-postasını devralmaz.
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, descriptionBu işleyicide isteğe bağlıdır, ancak seçilen ülke/operatör bunlardan bazılarını zorunlu kılabilir. O kayıt için gereken biçimleri sağlayın. Doğrudan API çağrıları, portalın gerçekleştirdiği her normalleştirmeyi otomatik olarak uygulamaz.

Bu doğrudan v3 işleyicisi adres alanlarını zorunlu kılar ve bir adres oluşturur. Portalın adres erteleme seçeneğinin bu işleyici üzerinden kullanılabildiğini varsaymayın.

Üç tanımlayıcının tümünü saklayın

Aşağıda seçili yanıt alanları gösterilmektedir; gerçek yanıt ayrıca gönderilen profil bilgilerini ve imza verisini de içerir. Yanıtın tamamını gizli olarak ele alın.

{
  "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 yerel profili tanımlar. Bunu get_document ile kullanın. documents ve get_document yanıtlarında aynı profil tanımlayıcısı id olarak adlandırılır.
  • response.identity_id sonraki kimlik kanıtları ve destekleyici belgeler için kimliği tanımlar.
  • response.address_id oluşturulan adresi tanımlar. Bunu ayrı olarak saklayın; yerel profil UUID'si bir adres kimliği değildir. Yeni oluşturulan profiller için sonraki adres kanıtı ekleme uyumluluğu hâlâ inceleme altındadır.

İki profil geri okuma uç noktası identity_id veya address_id değerlerini döndürmez; bu nedenle orijinal başarılı oluşturma yanıtını saklayın. Kaybolduysa, yedek bir profil oluşturmadan önce portal belge görünümünü kullanın veya destek ekibiyle iletişime geçin.

Gelişmiş: oluşturma sırasında önceden yüklenmiş kanıtları ekleme

İsterseniz identity_encryptfiles ve address_encryptfiles alanlarını, create_encrypt_files tarafından döndürülen kimliklerin dizileri olarak sağlayabilirsiniz. Eşleşen varlık kategorisine ait bir kanıt türü kullanarak yükleyin, ardından yaklaşık 20 dakikalık dosya referansı süresi dolmadan önce gönderin. Oluşturma işleyicisi, sağlanan her referansın hesabını, kategorisini ve son kullanma süresini denetler.

Bu alanlar, sonraki ekleme uç noktasının encrypted_file_ids alanından farklı adlara sahiptir. Oluşturma sırasında, birden fazla dosya aynı kanıt türünü paylaşsa bile her dosya ayrı bir kanıt isteği olarak gönderilir. Birden fazla dosyayı birlikte içermesi gereken bir kimlik kanıtı için, sonraki create_proof isteğini tek bir diziyle kullanın. Başarılı profil oluşturma tek başına tek tek kanıt onay sonuçlarını sağlamaz.

Yeni oluşturulan bir adres için sonraki bir adres kanıtı reddedilirse, onun yerine profil UUID'sini kullanmayın ve kimliği tekrar tekrar yeniden oluşturmayın. Durun ve profili portalda veya destek ekibiyle kontrol edin. Adres kanıtı geri okuma/arama yolu bir inceleme sınırlaması olmaya devam etmektedir.

Hatalar ve kısmi oluşturma

API kodu 400; alan doğrulamasını, operatör oluşturma hatalarını ve yerel kaydetme hatalarını kapsar. Doğrulama hataları, response içinde alan anahtarlı girdiler olarak görünebilir. Kod 500, kullanılamayan/geçersiz bir kayıt ülkesi için; kod 404 ise eksik veya süresi dolmuş önceden yüklenmiş referanslar için kullanılır. Kodun yanı sıra status.msg değerini de okuyun.

Yerel profil ve yukarı akış operatör işlemleri tek bir atomik işlem değildir. Başarısız bir istek, yerel bir profil listelenmese bile yukarı akışta durum bırakabilir. İstemci tarafı idempotans anahtarı sunulmaz. Zaman aşımı veya belirsiz bir hatadan sonra, oluşturmayı yinelemeden önce mevcut profilleri inceleyin ve destek ekibiyle iletişime geçin; boş bir documents listesi, yukarı akışta hiçbir şey oluşturulmadığının kanıtı değildir.