Izveidot reģistrācijas profilu

Izveidojiet profilu vienu reizi

Šis pieprasījums izveido lokālu reģistrācijas profilu kopā ar operatora identitātes un adreses ierakstiem. Sāciet ar aktuālajām reģistrācijas valstīm, numuru veidiem un prasībām. Prasības ir atkarīgas no valsts un numura veida, kuru plānojat reģistrēt.

Veiksmīga izveides atbilde nav regulatīvs apstiprinājums vai numura aktivizācija. Saglabājiet dokumenta UUID, identitātes ID un adreses ID atsevišķi: tiem ir dažādi mērķi. Šis pieprasījums maina konta datus un nav tikai validācijas darbība.

Izveides pieprasījums

Autentificējieties ar savu iespējoto MultiTEL API kontu un tā atļauto IP adresi. Piemēros tiek izmantoti HTTP Basic akreditācijas dati, kas glabājas vides mainīgajos. Pārbaudiet gan HTTP atbildi, gan JSON status.code; HTTP 200 atbilde pati par sevi neapliecina panākumus. Visas piemēru vērtības ir izdomātas.

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 ir ilustratīvs Personal profils, nevis iesniegšanai gatava reāla identitāte. Aizstājiet tā datus un parakstu ar galalietotāja informāciju, ko prasa izvēlētie reģistrācijas noteikumi. Tiek atbalstīta arī formas kodējuma ievade.

Reģistrācijas profila lauki
Lauks	Obligātums un formāts
`identity_type`	Obligāts. Izmantojiet precīzu vērtību Personal vai Business; nosacījumu validācija ir atkarīga no lielajiem un mazajiem burtiem.
`first_name, last_name`	Obligāti, katrs ne vairāk kā 64 rakstzīmes. Uzņēmumam norādiet pārstāvja datus, ko prasa izvēlētā valsts.
`phone_number`	Obligāta skaitliska tālruņa vērtība, vismaz astoņas rakstzīmes. Šai validācijai der starptautisks numurs tikai no cipariem, ieskaitot valsts kodu; tas ir kontakta numurs, nevis numura pirkums.
`city, postal_code, address`	Obligāti, katrs ne vairāk kā 64 rakstzīmes.
`country`	Obligāts adreses valsts ISO kods no reģistrācijas kataloga. Pakalpojums to piesaista operatora valsts ierakstam.
`signature`	Obligāti paraksta dati. Pašreizējais portāls nodrošina Base64 PNG attēla baitus bez data:image/png;base64, prefiksa. Iegūstiet galalietotāja parakstu, izmantojot savu autorizēto darbplūsmu; netukšs aizstājējs nav jēgpilns paraksts.
`nationality`	Obligāts Personal tipam kā valsts ISO kods. Neaizstājiet to ar valsts UUID.
`company_name, incorporation_country`	Obligāts Business tipam. Uzņēmuma nosaukums ir ne vairāk kā 64 rakstzīmes; incorporation_country ir valsts ISO kods.
`email`	Neobligāts galalietotāja kontakta e-pasts, ne vairāk kā 254 rakstzīmes. Izlaists vai tukšs e-pasts nepārmanto pamatkonta e-pastu.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Šajā apstrādātājā neobligāti, taču izvēlētā valsts/operators var pieprasīt dažus no tiem. Norādiet šai reģistrācijai nepieciešamos formātus. Tiešie API izsaukumi automātiski nepiemēro visas portāla veiktās normalizācijas.

Šis tiešais v3 apstrādātājs prasa adreses laukus un izveido adresi. Nepieņemiet, ka portāla adreses atlikšanas opcija ir pieejama caur to.

Saglabājiet visus trīs identifikatorus

Tālāk ir parādīti atlasīti atbildes lauki; faktiskā atbilde satur arī iesniegto profila informāciju un paraksta datus. Apstrādājiet pilno atbildi kā privātu.

{
  "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 identificē lokālo profilu. Izmantojiet to ar get_document. Atbildēs no documents un get_document tam pašam profila identifikatoram ir nosaukums id.
response.identity_id identificē identitāti vēlākiem identitātes pierādījumiem un apliecinošiem dokumentiem.
response.address_id identificē izveidoto adresi. Glabājiet to atsevišķi; lokālā profila UUID nav adreses ID. Vēlākas adreses pierādījuma pievienošanas saderība jaunizveidotiem profiliem joprojām tiek pārskatīta.

Abi profila nolasīšanas galapunkti neatgriež identity_id vai address_id, tāpēc saglabājiet sākotnējo veiksmīgo izveides atbildi. Ja tā ir zaudēta, izmantojiet portāla dokumentu skatu vai sazinieties ar atbalsta dienestu, pirms izveidojat aizstājēju.

Papildu iespēja: pievienojiet iepriekš augšupielādētus pierādījumus izveides laikā

Varat norādīt identity_encryptfiles un address_encryptfiles kā ID masīvus, ko atgriež create_encrypt_files. Augšupielādējiet, izmantojot atbilstošās entītijas kategorijas pierādījuma tipu, un pēc tam iesniedziet pirms aptuveni 20 minūšu faila atsauces derīguma beigām. Izveides apstrādātājs pārbauda katras norādītās atsauces kontu, kategoriju un derīguma termiņu.

Šo lauku nosaukumi atšķiras no vēlākā pievienošanas galapunkta lauka encrypted_file_ids. Izveides laikā katrs fails tiek nosūtīts kā atsevišķs pierādījuma pieprasījums pat tad, ja vairākiem failiem ir viens pierādījuma tips. Identitātes pierādījumam, kurā kopā jābūt vairākiem failiem, izmantojiet vēlāko create_proof pieprasījumu ar vienu masīvu. Veiksmīga profila izveide pati par sevi nesniedz atsevišķu pierādījumu apstiprināšanas rezultātus.

Ja vēlāks adreses pierādījums jaunizveidotai adresei tiek noraidīts, neaizstājiet to ar profila UUID un atkārtoti neveidojiet identitāti. Apstājieties un pārbaudiet profilu portālā vai ar atbalsta dienestu. Adreses pierādījuma nolasīšanas/meklēšanas ceļš joprojām ir pārskatīšanas ierobežojums.

Kļūmes un daļēja izveide

API kods 400 aptver lauku validāciju, operatora izveides kļūmes un lokālās saglabāšanas kļūmes. Validācijas kļūdas var parādīties kā pēc laukiem atslēgoti ieraksti response daļā. Kods 500 tiek izmantots nepieejamai/nederīgai reģistrācijas valstij, bet kods 404 trūkstošām vai beigušos termiņu iepriekš augšupielādētām atsaucēm. Lasiet status.msg, ne tikai kodu.

Lokālā profila un augšupējās operatora darbības nav viena atomāra transakcija. Neizdevies pieprasījums var atstāt augšupējo stāvokli pat tad, ja neviens lokālais profils nav uzskaitīts. Klienta idempotences atslēga netiek piedāvāta. Pēc noildzes vai neskaidras kļūmes pārbaudiet esošos profilus un sazinieties ar atbalsta dienestu, pirms atkārtojat izveidi; tukšs documents saraksts nav pierādījums, ka augšup nekas netika izveidots.