Vytvoření registračního profilu

Vytvořte profil jednou

Tento požadavek vytvoří místní registrační profil společně se záznamy identity a adresy u operátora. Začněte aktuálními registračními zeměmi, typy čísel a požadavky. Požadavky závisí na zemi a typu čísla, které plánujete registrovat.

Úspěšná odpověď na vytvoření není regulatorním schválením ani aktivací čísla. Uložte UUID dokumentu, ID identity a ID adresy samostatně: slouží různým účelům. Tento požadavek mění data účtu a není operací určenou pouze k validaci.

Požadavek na vytvoření

Ověřte se svým povoleným účtem MultiTEL API a jeho povolenou IP adresou. Příklady používají přihlašovací údaje HTTP Basic uložené v proměnných prostředí. Zkontrolujte jak HTTP odpověď, tak JSON status.code; samotná HTTP odpověď 200 úspěch neprokazuje. Všechny ukázkové hodnoty jsou smyšlené.

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

Tento JSON je ilustrativní profil Personal, nikoli skutečná identita připravená k odeslání. Nahraďte jeho údaje a podpis informacemi o koncovém uživateli, které vyžadují zvolená registrační pravidla. Podporován je také vstup kódovaný jako formulář.

Pole registračního profilu
Pole	Povinnost a formát
`identity_type`	Povinné. Použijte přesnou hodnotu Personal nebo Business; podmíněná validace závisí na velikosti písmen.
`first_name, last_name`	Povinné, každé nejvýše 64 znaků. U firmy uveďte údaje o zástupci požadované zvolenou zemí.
`phone_number`	Povinná číselná telefonní hodnota, nejméně osm znaků. Pro tuto validaci je vhodné mezinárodní číslo tvořené pouze číslicemi včetně kódu země; jde o kontaktní číslo, nikoli o nákup čísla.
`city, postal_code, address`	Povinné, každé nejvýše 64 znaků.
`country`	Povinný ISO kód země adresy z registračního katalogu. Služba jej převede na záznam země u operátora.
`signature`	Povinná data podpisu. Aktuální portál dodává bajty obrázku PNG v kódování Base64 bez prefixu data:image/png;base64,. Podpis koncového uživatele získejte prostřednictvím svého autorizovaného postupu; neprázdný zástupný text není smysluplným podpisem.
`nationality`	Povinné pro Personal, jako ISO kód země. Nenahrazujte jej UUID země.
`company_name, incorporation_country`	Povinné pro Business. Název společnosti má nejvýše 64 znaků; incorporation_country je ISO kód země.
`email`	Volitelný kontaktní e-mail koncového uživatele, nejvýše 254 znaků. Vynechaný nebo prázdný e-mail nepřebírá e-mail základního účtu.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	V této obslužné rutině volitelné, ale zvolená země/operátor může některé z nich vyžadovat. Dodejte formáty požadované pro danou registraci. Přímá volání API automaticky neprovádějí každou normalizaci, kterou provádí portál.

Tato přímá obslužná rutina v3 vyžaduje pole adresy a vytváří adresu. Nepředpokládejte, že je přes ni dostupná možnost portálu odložit zadání adresy.

Uchovejte všechny tři identifikátory

Následující ukázka zobrazuje vybraná pole odpovědi; skutečná odpověď obsahuje také odeslané informace o profilu a data podpisu. S celou odpovědí zacházejte jako se soukromou.

{
  "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 identifikuje místní profil. Použijte jej s get_document. V odpovědích documents a get_document se stejný identifikátor profilu nazývá id.
response.identity_id identifikuje identitu pro pozdější doklady identity a podpůrné dokumenty.
response.address_id identifikuje vytvořenou adresu. Uchovávejte jej samostatně; UUID místního profilu není ID adresy. Kompatibilita pozdějšího připojení dokladu adresy u nově vytvořených profilů je stále v revizi.

Dva koncové body pro zpětné čtení profilu nevracejí identity_id ani address_id, proto uchovejte původní úspěšnou odpověď na vytvoření. Pokud byla ztracena, před vytvořením náhrady použijte zobrazení dokumentu na portálu nebo kontaktujte podporu.

Pokročilé: připojení předem nahraných dokladů během vytváření

Můžete zadat identity_encryptfiles a address_encryptfiles jako pole ID vrácených koncovým bodem create_encrypt_files. Nahrajte je s typem dokladu pro odpovídající kategorii entity a poté odešlete před vypršením platnosti odkazu na soubor, která činí přibližně 20 minut. Obslužná rutina vytvoření kontroluje účet, kategorii a platnost každého dodaného odkazu.

Tato pole mají jiné názvy než encrypted_file_ids pozdějšího koncového bodu pro připojení. Během vytváření je každý soubor odeslán jako samostatný požadavek na doklad, i když několik souborů sdílí jeden typ dokladu. Pro doklad identity, který musí obsahovat několik souborů společně, použijte pozdější požadavek create_proof s jedním polem. Úspěšné vytvoření profilu samo o sobě neposkytuje výsledky schválení jednotlivých dokladů.

Pokud je pozdější doklad adresy pro nově vytvořenou adresu zamítnut, nenahrazujte jej UUID profilu ani opakovaně nevytvářejte identitu znovu. Zastavte se a zkontrolujte profil na portálu nebo s podporou. Cesta zpětného čtení/vyhledání dokladu adresy zůstává omezením revize.

Selhání a částečné vytvoření

Kód API 400 pokrývá validaci polí, selhání vytvoření u operátora a selhání místního uložení. Chyby validace se mohou objevit jako položky klíčované podle pole v response. Kód 500 se používá pro nedostupnou/neplatnou registrační zemi a kód 404 pro chybějící nebo prošlé předem nahrané odkazy. Čtěte status.msg i kód.

Místní profil a operace u nadřazeného operátora nejsou jednou atomickou transakcí. Neúspěšný požadavek může zanechat stav u operátora, i když není uveden žádný místní profil. Není vystaven žádný klientský idempotenční klíč. Po vypršení časového limitu nebo nejisté chybě zkontrolujte existující profily a před opakováním vytvoření kontaktujte podporu; prázdný seznam documents není důkazem, že u operátora nebylo nic vytvořeno.