Sukurti registracijos profilį

Sukurkite profilį tik vieną kartą

Ši užklausa sukuria vietinį registracijos profilį kartu su operatoriaus tapatybės ir adreso įrašais. Pradėkite nuo dabartinių registracijos šalių, numerių tipų ir reikalavimų. Reikalavimai priklauso nuo šalies ir numerio tipo, kurį planuojate registruoti.

Sėkmingas kūrimo atsakymas nėra reguliavimo institucijos patvirtinimas ar numerio aktyvavimas. Dokumento UUID, tapatybės ID ir adreso ID išsaugokite atskirai: jie skirti skirtingiems tikslams. Ši užklausa keičia paskyros duomenis ir nėra vien tik tikrinimo operacija.

Kūrimo užklausa

Autentifikuokitės naudodami savo įjungtą MultiTEL API paskyrą ir jai leidžiamą IP adresą. Pavyzdžiuose naudojami HTTP Basic kredencialai, saugomi aplinkos kintamuosiuose. Tikrinkite ir HTTP atsakymą, ir JSON lauką status.code; vien HTTP 200 atsakymas sėkmės nepatvirtina. Visos pavyzdinės reikšmės yra išgalvotos.

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

Šis JSON yra iliustracinis Personal profilis, o ne paruošta pateikti tikra tapatybė. Pakeiskite jo duomenis ir parašą galutinio naudotojo informacija, kurios reikalauja pasirinktos registracijos taisyklės. Taip pat palaikoma formos koduotės (form-encoded) įvestis.

Registracijos profilio laukai
Laukas	Privalomumas ir formatas
`identity_type`	Privalomas. Naudokite tikslią reikšmę Personal arba Business; sąlyginis tikrinimas priklauso nuo didžiųjų ir mažųjų raidžių.
`first_name, last_name`	Privalomi, kiekvienas ne ilgesnis kaip 64 simboliai. Įmonės atveju nurodykite atstovo duomenis, kurių reikalauja pasirinkta šalis.
`phone_number`	Privaloma skaitinė telefono reikšmė, ne trumpesnė kaip aštuoni simboliai. Šiam tikrinimui tinka tik iš skaitmenų sudarytas tarptautinis numeris su šalies kodu; tai kontaktinis numeris, o ne numerio pirkimas.
`city, postal_code, address`	Privalomi, kiekvienas ne ilgesnis kaip 64 simboliai.
`country`	Privalomas adreso šalies ISO kodas iš registracijos katalogo. Paslauga susieja jį su operatoriaus šalies įrašu.
`signature`	Privalomi parašo duomenys. Dabartinis portalas pateikia Base64 koduotus PNG paveikslėlio baitus be data:image/png;base64, prefikso. Galutinio naudotojo parašą gaukite per savo įgaliotą procesą; netuščias vietos rezervavimo tekstas nėra prasmingas parašas.
`nationality`	Privalomas Personal tipui, kaip šalies ISO kodas. Nekeiskite jo šalies UUID.
`company_name, incorporation_country`	Privalomi Business tipui. Įmonės pavadinimas ne ilgesnis kaip 64 simboliai; incorporation_country yra šalies ISO kodas.
`email`	Neprivalomas galutinio naudotojo kontaktinis el. pašto adresas, ne ilgesnis kaip 254 simboliai. Praleistas arba tuščias el. paštas neperima bazinės paskyros el. pašto adreso.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Šiame apdoroklyje neprivalomi, tačiau pasirinkta šalis arba operatorius gali reikalauti kai kurių iš jų. Pateikite tai registracijai reikalaujamus formatus. Tiesioginiai API iškvietimai automatiškai nepritaiko visų portalo atliekamų normalizavimų.

Šis tiesioginis v3 apdoroklis reikalauja adreso laukų ir sukuria adresą. Nemanykite, kad per jį prieinama portalo adreso atidėjimo parinktis.

Išsaugokite visus tris identifikatorius

Toliau pateikiami tik pasirinkti atsakymo laukai; tikrajame atsakyme taip pat yra pateikta profilio informacija ir parašo duomenys. Visą atsakymą tvarkykite kaip privatų.

{
  "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 identifikuoja vietinį profilį. Naudokite jį su get_document. Užklausų documents ir get_document atsakymuose tas pats profilio identifikatorius vadinamas id.
response.identity_id identifikuoja tapatybę vėlesniems tapatybės įrodymams ir patvirtinamiesiems dokumentams.
response.address_id identifikuoja sukurtą adresą. Saugokite jį atskirai; vietinio profilio UUID nėra adreso ID. Vėlesnio adreso įrodymų pridėjimo suderinamumas naujai sukurtiems profiliams dar peržiūrimas.

Du profilio nuskaitymo galiniai taškai negrąžina identity_id ar address_id, todėl išsaugokite pirminį sėkmingą kūrimo atsakymą. Jei jis prarastas, naudokite portalo dokumentų rodinį arba kreipkitės į palaikymo tarnybą prieš kurdami pakaitinį profilį.

Išplėstinė galimybė: iš anksto įkeltų įrodymų pridėjimas kūrimo metu

Galite pateikti identity_encryptfiles ir address_encryptfiles kaip ID masyvus, kuriuos grąžina create_encrypt_files. Įkelkite naudodami atitinkamos subjekto kategorijos įrodymo tipą, tada pateikite užklausą prieš pasibaigiant maždaug 20 minučių failo nuorodos galiojimui. Kūrimo apdoroklis tikrina kiekvienos pateiktos nuorodos paskyrą, kategoriją ir galiojimo pabaigą.

Šių laukų pavadinimai skiriasi nuo vėlesnio pridėjimo galinio taško lauko encrypted_file_ids. Kūrimo metu kiekvienas failas siunčiamas kaip atskira įrodymo užklausa, net kai keli failai turi tą patį įrodymo tipą. Tapatybės įrodymui, kuriame kartu turi būti keli failai, naudokite vėlesnę create_proof užklausą su vienu masyvu. Vien sėkmingas profilio sukūrimas nepateikia atskirų įrodymų patvirtinimo rezultatų.

Jei vėlesnis naujai sukurto adreso įrodymas atmetamas, nekeiskite jo profilio UUID ir nekurkite tapatybės pakartotinai. Sustokite ir patikrinkite profilį portale arba su palaikymo tarnyba. Adreso įrodymų nuskaitymo / paieškos kelias tebėra peržiūros apribojimas.

Klaidos ir dalinis sukūrimas

API kodas 400 apima laukų tikrinimo klaidas, operatoriaus kūrimo klaidas ir vietinio išsaugojimo klaidas. Tikrinimo klaidos gali būti pateiktos kaip pagal laukus suskirstyti įrašai response objekte. Kodas 500 naudojamas nepasiekiamai arba negaliojančiai registracijos šaliai, o kodas 404 skirtas trūkstamoms arba pasibaigusio galiojimo iš anksto įkeltoms nuorodoms. Skaitykite ne tik kodą, bet ir status.msg.

Vietinio profilio ir aukštesnės grandies operatoriaus operacijos nėra viena atominė transakcija. Nepavykusi užklausa gali palikti būseną operatoriaus pusėje net tada, kai vietinis profilis sąraše nerodomas. Kliento idempotentiškumo raktas neteikiamas. Pasibaigus skirtajam laikui ar įvykus neaiškiai klaidai patikrinkite esamus profilius ir kreipkitės į palaikymo tarnybą prieš kartodami kūrimą; tuščias documents sąrašas nėra įrodymas, kad operatoriaus pusėje nieko nebuvo sukurta.