Registreerimisprofiili loomine

Looge profiil üks kord

See päring loob kohaliku registreerimisprofiili koos operaatori identiteedi- ja aadressikirjetega. Alustage praegustest registreerimisriikidest, numbritüüpidest ja nõuetest. Nõuded sõltuvad riigist ja numbri tüübist, mida kavatsete registreerida.

Edukas loomisvastus ei ole regulatiivne heakskiit ega numbri aktiveerimine. Salvestage dokumendi UUID, identiteedi ID ja aadressi ID eraldi: neil on erinev otstarve. See päring muudab konto andmeid ega ole ainult valideerimistoiming.

Loomispäring

Autentige oma lubatud MultiTEL API konto ja selle lubatud IP-aadressiga. Näidetes kasutatakse keskkonnamuutujates hoitavaid HTTP Basic mandaate. Kontrollige nii HTTP vastust kui ka JSON-i status.code; ainuüksi HTTP 200 vastus ei tõenda edu. Kõik näidisväärtused on väljamõeldud.

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

See JSON on illustreeriv Personal profiil, mitte esitamiseks valmis tegelik identiteet. Asendage selle andmed ja allkiri lõppkasutaja teabega, mida valitud registreerimisreeglid nõuavad. Toetatud on ka vormikodeeritud sisend.

Registreerimisprofiili väljad
Väli	Kohustuslikkus ja vorming
`identity_type`	Kohustuslik. Kasutage täpset väärtust Personal või Business; tingimuslik valideerimine sõltub suur- ja väiketähtedest.
`first_name, last_name`	Kohustuslik, kumbki kuni 64 märki. Ettevõtte puhul esitage valitud riigis nõutavad esindaja andmed.
`phone_number`	Kohustuslik numbriline telefoniväärtus, vähemalt kaheksa märki. Selle valideerimise jaoks sobib ainult numbritest koosnev rahvusvaheline number koos riigikoodiga; see on kontaktnumber, mitte numbri ost.
`city, postal_code, address`	Kohustuslik, igaüks kuni 64 märki.
`country`	Kohustuslik aadressiriigi ISO-kood registreerimiskataloogist. Teenus seostab selle operaatori riigikirjega.
`signature`	Kohustuslikud allkirjaandmed. Praegune portaal edastab Base64 PNG-pildi baidid ilma data:image/png;base64, eesliiteta. Hankige lõppkasutaja allkiri oma volitatud töövoo kaudu; mittetühi kohatäide ei ole sisuline allkiri.
`nationality`	Kohustuslik tüübi Personal puhul riigi ISO-koodina. Ärge asendage seda riigi UUID-ga.
`company_name, incorporation_country`	Kohustuslik tüübi Business puhul. Ettevõtte nimi on kuni 64 märki; incorporation_country on riigi ISO-kood.
`email`	Valikuline lõppkasutaja kontakt-e-post, kuni 254 märki. Puuduv või tühi e-post ei päri põhikonto e-posti.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Selles töötlejas valikulised, kuid valitud riik/operaator võib mõnda neist nõuda. Esitage selle registreerimise jaoks nõutavad vormingud. Otsesed API-kutsed ei rakenda automaatselt kõiki portaali tehtavaid normaliseerimisi.

See otsene v3 töötleja nõuab aadressivälju ja loob aadressi. Ärge eeldage, et portaali aadressi edasilükkamise valik on selle kaudu saadaval.

Säilitage kõik kolm identifikaatorit

Allpool on näidatud valitud vastuse väljad; tegelik vastus sisaldab ka esitatud profiiliteavet ja allkirjaandmeid. Käsitlege kogu vastust privaatsena.

{
  "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 identifitseerib kohaliku profiili. Kasutage seda koos päringuga get_document. Vastustes documents ja get_document kannab sama profiili identifikaator nime id.
response.identity_id identifitseerib identiteedi hilisemate identiteeditõendite ja tõendavate dokumentide jaoks.
response.address_id identifitseerib loodud aadressi. Hoidke seda eraldi; kohaliku profiili UUID ei ole aadressi ID. Hilisema aadressitõendi manustamise ühilduvus äsja loodud profiilide puhul on veel ülevaatamisel.

Kaks profiili tagasilugemise lõpp-punkti ei tagasta identity_id ega address_id, seega säilitage algne edukas loomisvastus. Kui see on kadunud, kasutage portaali dokumendivaadet või võtke enne asendaja loomist ühendust toega.

Täpsem: eelnevalt üleslaaditud tõendite lisamine loomise ajal

Võite esitada identity_encryptfiles ja address_encryptfiles ID-de massiividena, mille tagastab create_encrypt_files. Laadige üles vastava olemikategooria tõenditüübiga ja esitage seejärel enne failiviite umbes 20-minutilise kehtivuse lõppu. Loomistöötleja kontrollib iga esitatud viite kontot, kategooriat ja kehtivust.

Nende väljade nimed erinevad hilisema manustamise lõpp-punkti väljast encrypted_file_ids. Loomise ajal saadetakse iga fail eraldi tõendipäringuna isegi siis, kui mitu faili jagavad ühte tõenditüüpi. Identiteeditõendi jaoks, mis peab sisaldama mitut faili koos, kasutage hilisemat create_proof päringut ühe massiiviga. Profiili edukas loomine üksi ei anna üksikute tõendite kinnitamise tulemusi.

Kui hilisem aadressitõend lükatakse äsja loodud aadressi puhul tagasi, ärge asendage seda profiili UUID-ga ega looge identiteeti korduvalt uuesti. Peatuge ja kontrollige profiili portaalis või koos toega. Aadressitõendi tagasilugemise/otsingu tee jääb ülevaatuse piiranguks.

Tõrked ja osaline loomine

API kood 400 hõlmab väljade valideerimist, operaatoripoolseid loomistõrkeid ja kohalikke salvestustõrkeid. Valideerimisvead võivad ilmuda väljapõhiste kirjetena väljal response. Koodi 500 kasutatakse kättesaamatu/kehtetu registreerimisriigi puhul ja koodi 404 puuduvate või aegunud eelnevalt üleslaaditud viidete puhul. Lugege lisaks koodile ka status.msg.

Kohaliku profiili ja ülesvoolu operaatori toimingud ei ole üks atomaarne tehing. Ebaõnnestunud päring võib jätta ülesvoolu oleku ka siis, kui ühtegi kohalikku profiili ei ole loetletud. Kliendi idempotentsusvõtit ei pakuta. Pärast ajalõppu või ebaselget tõrget kontrollige olemasolevaid profiile ja võtke enne loomise kordamist ühendust toega; tühi documents loend ei tõenda, et ülesvoolu midagi ei loodud.