Izrada registracijskog profila

Izradite profil samo jednom

Ovaj zahtjev stvara lokalni registracijski profil zajedno sa zapisima identiteta i adrese kod operatera. Započnite s trenutačnim zemljama za registraciju, vrstama brojeva i zahtjevima. Zahtjevi ovise o zemlji i vrsti broja koji namjeravate registrirati.

Uspješan odgovor na izradu nije regulatorno odobrenje ni aktivacija broja. Spremite UUID dokumenta, ID identiteta i ID adrese zasebno: služe različitim svrhama. Ovaj zahtjev mijenja podatke računa i nije operacija koja služi samo za validaciju.

Zahtjev za izradu

Autentificirajte se svojim omogućenim MultiTEL API računom i njegovom dopuštenom IP adresom. Primjeri koriste HTTP Basic vjerodajnice pohranjene u varijablama okruženja. Provjerite i HTTP odgovor i JSON polje status.code; sam HTTP 200 odgovor ne dokazuje uspjeh. Sve vrijednosti u primjerima izmišljene su.

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 je ilustrativni Personal profil, a ne stvarni identitet spreman za slanje. Zamijenite njegove podatke i potpis podacima krajnjeg korisnika koje zahtijevaju odabrana pravila registracije. Podržan je i unos kodiran kao obrazac.

Polja registracijskog profila
Polje	Obveznost i format
`identity_type`	Obvezno. Upotrijebite točnu vrijednost Personal ili Business; uvjetna validacija ovisi o velikim i malim slovima.
`first_name, last_name`	Obvezno, svako najviše 64 znaka. Za tvrtku navedite podatke o predstavniku koje zahtijeva odabrana zemlja.
`phone_number`	Obvezna numerička telefonska vrijednost od najmanje osam znakova. Međunarodni broj sastavljen samo od znamenki, uključujući pozivni broj zemlje, prikladan je za ovu validaciju; ovo je kontaktni broj, a ne kupnja broja.
`city, postal_code, address`	Obvezno, svako najviše 64 znaka.
`country`	Obvezan ISO kod zemlje adrese iz registracijskog kataloga. Usluga ga razrješava u zapis zemlje kod operatera.
`signature`	Obvezni podaci o potpisu. Trenutačni portal dostavlja bajtove PNG slike kodirane u Base64 bez prefiksa data:image/png;base64,. Potpis krajnjeg korisnika pribavite putem svojeg ovlaštenog tijeka rada; neprazna zamjenska vrijednost nije smislen potpis.
`nationality`	Obvezno za Personal, kao ISO kod zemlje. Nemojte umjesto toga koristiti UUID zemlje.
`company_name, incorporation_country`	Obvezno za Business. Naziv tvrtke može imati najviše 64 znaka; incorporation_country je ISO kod zemlje.
`email`	Neobvezna kontaktna e-pošta krajnjeg korisnika, najviše 254 znaka. Izostavljena ili prazna e-pošta ne nasljeđuje e-poštu osnovnog računa.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Neobvezno u ovom rukovatelju, ali odabrana zemlja/operater može zahtijevati neka od njih. Navedite formate koje ta registracija zahtijeva. Izravni API pozivi ne primjenjuju automatski svaku normalizaciju koju provodi portal.

Ovaj izravni v3 rukovatelj zahtijeva polja adrese i stvara adresu. Nemojte pretpostavljati da je opcija portala za odgodu adrese dostupna putem njega.

Zadržite sva tri identifikatora

U nastavku su prikazana odabrana polja odgovora; stvarni odgovor sadrži i poslane podatke profila te podatke o potpisu. Cijeli odgovor tretirajte kao privatan.

{
  "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 identificira lokalni profil. Koristite ga uz get_document. U odgovorima documents i get_document isti identifikator profila naziva se id.
response.identity_id identificira identitet za kasnije dokaze identiteta i popratne dokumente.
response.address_id identificira stvorenu adresu. Čuvajte ga zasebno; UUID lokalnog profila nije ID adrese. Kompatibilnost kasnijeg prilaganja dokaza adrese za novostvorene profile još je u pregledu.

Dvije krajnje točke za očitavanje profila ne vraćaju identity_id ni address_id, stoga zadržite izvorni uspješni odgovor na izradu. Ako je izgubljen, upotrijebite prikaz dokumenata na portalu ili se obratite podršci prije izrade zamjene.

Napredno: prilaganje unaprijed prenesenih dokaza tijekom izrade

Možete navesti identity_encryptfiles i address_encryptfiles kao polja ID-ova koje vraća create_encrypt_files. Prenesite ih koristeći vrstu dokaza za odgovarajuću kategoriju entiteta, a zatim pošaljite prije isteka reference datoteke nakon otprilike 20 minuta. Rukovatelj izrade provjerava račun, kategoriju i istek svake navedene reference.

Ta polja imaju drukčije nazive od polja encrypted_file_ids kasnije krajnje točke za prilaganje. Tijekom izrade svaka se datoteka šalje kao zaseban zahtjev za dokaz, čak i kada više datoteka dijeli istu vrstu dokaza. Za dokaz identiteta koji mora sadržavati više datoteka zajedno upotrijebite kasniji zahtjev create_proof s jednim poljem. Sama uspješna izrada profila ne daje pojedinačne rezultate odobrenja dokaza.

Ako je kasniji dokaz adrese odbijen za novostvorenu adresu, nemojte umjesto toga koristiti UUID profila niti opetovano ponovno stvarati identitet. Zaustavite se i provjerite profil na portalu ili s podrškom. Put za očitavanje/pretraživanje dokaza adrese i dalje je ograničenje pregleda.

Neuspjesi i djelomična izrada

API kod 400 pokriva validaciju polja, neuspjehe izrade kod operatera i neuspjehe lokalnog spremanja. Pogreške validacije mogu se pojaviti kao unosi označeni ključem polja u response. Kod 500 koristi se za nedostupnu/nevažeću zemlju registracije, a kod 404 za nedostajuće ili istekle unaprijed prenesene reference. Pročitajte status.msg kao i kod.

Lokalni profil i operacije kod uzvodnog operatera nisu jedna atomska transakcija. Neuspjeli zahtjev može ostaviti stanje uzvodno čak i kada nijedan lokalni profil nije naveden. Ne izlaže se nikakav klijentski ključ idempotentnosti. Nakon isteka vremena ili neizvjesnog neuspjeha pregledajte postojeće profile i obratite se podršci prije ponavljanja izrade; prazan popis documents nije dokaz da uzvodno ništa nije stvoreno.