Kehittäjät

POST/v3/create_document

Luo rekisteröintiprofiili

Luo henkilöllisyys-/osoiteprofiili ja säilytä sen erilliset profiili- ja entiteettitunnisteet.

Tällä sivulla
  1. Luo profiili vain kerran
  2. Luontipyyntö
  3. Säilytä kaikki kolme tunnistetta
  4. Edistynyt: liitä etukäteen ladatut todisteet luonnin yhteydessä
  5. Virheet ja osittainen luonti

Luo profiili vain kerran

Tämä pyyntö luo paikallisen rekisteröintiprofiilin yhdessä operaattorin henkilöllisyys- ja osoitetietueiden kanssa. Aloita ajantasaisista rekisteröintimaista, numerotyypeistä ja vaatimuksista. Vaatimukset riippuvat maasta ja rekisteröitävän numeron tyypistä.

Onnistunut luontivastaus ei ole viranomaishyväksyntä eikä numeron aktivointi. Tallenna dokumentin UUID, henkilöllisyystunnus ja osoitetunnus erikseen: niillä on eri käyttötarkoitukset. Tämä pyyntö muuttaa tilin tietoja eikä ole pelkkä validointitoiminto.

Luontipyyntö

Todenna käyttöön otetulla MultiTEL API -tililläsi ja sen sallitulla IP-osoitteella. Esimerkeissä käytetään ympäristömuuttujiin tallennettuja HTTP Basic -tunnuksia. Tarkista sekä HTTP-vastaus että JSON-kenttä status.code; pelkkä HTTP 200 -vastaus ei todista onnistumista. Kaikki esimerkkiarvot ovat kuvitteellisia.

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 on havainnollistava Personal-profiili, ei lähetysvalmis todellinen henkilöllisyys. Korvaa sen tiedot ja allekirjoitus loppukäyttäjän tiedoilla, joita valitut rekisteröintisäännöt edellyttävät. Myös lomakekoodattu syöte on tuettu.

Rekisteröintiprofiilin kentät
KenttäPakollisuus ja muoto
identity_typePakollinen. Käytä täsmälleen arvoa Personal tai Business; ehdollinen validointi riippuu kirjainkoosta.
first_name, last_namePakollinen, kumpikin enintään 64 merkkiä. Yrityksen tapauksessa anna valitun maan edellyttämät edustajan tiedot.
phone_numberPakollinen numeerinen puhelinarvo, vähintään kahdeksan merkkiä. Pelkistä numeroista koostuva kansainvälinen numero maakoodeineen sopii tähän validointiin; kyseessä on yhteysnumero, ei numeron osto.
city, postal_code, addressPakollinen, kukin enintään 64 merkkiä.
countryPakollinen osoitemaan ISO-koodi rekisteröintiluettelosta. Palvelu kohdistaa sen operaattorin maatietueeseen.
signaturePakolliset allekirjoitustiedot. Nykyinen portaali toimittaa Base64-koodatut PNG-kuvatavut ilman data:image/png;base64,-etuliitettä. Hanki loppukäyttäjän allekirjoitus valtuutetun työnkulkusi kautta; ei-tyhjä paikkamerkki ei ole merkityksellinen allekirjoitus.
nationalityPakollinen tyypille Personal, maan ISO-koodina. Älä korvaa sitä maan UUID-tunnuksella.
company_name, incorporation_countryPakollinen tyypille Business. Yrityksen nimi on enintään 64 merkkiä; incorporation_country on maan ISO-koodi.
emailValinnainen loppukäyttäjän yhteyssähköposti, enintään 254 merkkiä. Pois jätetty tai tyhjä sähköposti ei peri perustilin sähköpostiosoitetta.
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, descriptionValinnaisia tässä käsittelijässä, mutta valittu maa/operaattori voi vaatia joitakin niistä. Anna kyseisen rekisteröinnin edellyttämät muodot. Suorat API-kutsut eivät automaattisesti tee kaikkia portaalin suorittamia normalisointeja.

Tämä suora v3-käsittelijä vaatii osoitekentät ja luo osoitteen. Älä oleta, että portaalin osoitteen lykkäysvaihtoehto on käytettävissä sen kautta.

Säilytä kaikki kolme tunnistetta

Alla näytetään valikoituja vastauskenttiä; todellinen vastaus sisältää myös lähetetyt profiilitiedot ja allekirjoitustiedot. Käsittele koko vastausta yksityisenä.

{
  "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 yksilöi paikallisen profiilin. Käytä sitä yhdessä kutsun get_document kanssa. Kutsujen documents ja get_document vastauksissa sama profiilitunniste on nimeltään id.
  • response.identity_id yksilöi henkilöllisyyden, johon liitetään myöhemmin henkilöllisyystodisteet ja tukiasiakirjat.
  • response.address_id yksilöi luodun osoitteen. Säilytä se erikseen; paikallisen profiilin UUID ei ole osoitetunnus. Osoitetodisteiden myöhemmän liittämisen yhteensopivuus vasta luotujen profiilien kanssa on edelleen katselmoitavana.

Profiilin kaksi lukupäätepistettä eivät palauta tunnisteita identity_id tai address_id, joten säilytä alkuperäinen onnistunut luontivastaus. Jos se on kadonnut, käytä portaalin dokumenttinäkymää tai ota yhteyttä tukeen ennen korvaavan profiilin luomista.

Edistynyt: liitä etukäteen ladatut todisteet luonnin yhteydessä

Voit antaa kentät identity_encryptfiles ja address_encryptfiles taulukkoina tunnisteista, jotka create_encrypt_files palauttaa. Lataa käyttäen vastaavan entiteettiluokan todistetyyppiä ja lähetä sitten ennen tiedostoviitteen noin 20 minuutin vanhenemisaikaa. Luontikäsittelijä tarkistaa jokaisen annetun viitteen tilin, luokan ja vanhenemisen.

Näillä kentillä on eri nimet kuin myöhemmän liitepäätepisteen kentällä encrypted_file_ids. Luonnin aikana jokainen tiedosto lähetetään erillisenä todistepyyntönä, vaikka useat tiedostot jakaisivat saman todistetyypin. Jos henkilöllisyystodisteen on sisällettävä useita tiedostoja yhdessä, käytä myöhempää create_proof-pyyntöä yhdellä taulukolla. Onnistunut profiilin luonti ei yksinään anna yksittäisten todisteiden hyväksyntätuloksia.

Jos myöhempi osoitetodiste hylätään vasta luodulle osoitteelle, älä korvaa sitä profiilin UUID-tunnuksella äläkä luo henkilöllisyyttä toistuvasti uudelleen. Pysähdy ja tarkista profiili portaalissa tai tuen kanssa. Osoitetodisteiden luku-/hakupolku on edelleen katselmoinnin rajoitus.

Virheet ja osittainen luonti

API-koodi 400 kattaa kenttien validoinnin, operaattorin luontivirheet ja paikalliset tallennusvirheet. Validointivirheet voivat näkyä kenttäkohtaisina merkintöinä kentässä response. Koodia 500 käytetään, kun rekisteröintimaa ei ole käytettävissä tai on virheellinen, ja koodia 404, kun etukäteen ladatut viitteet puuttuvat tai ovat vanhentuneet. Lue koodin lisäksi myös status.msg.

Paikallinen profiili ja ylävirran operaattoritoiminnot eivät ole yksi atominen transaktio. Epäonnistunut pyyntö voi jättää tilatietoja ylävirran järjestelmään, vaikka paikallista profiilia ei näy luettelossa. Asiakkaan idempotenssiavainta ei ole käytettävissä. Aikakatkaisun tai epäselvän virheen jälkeen tarkista olemassa olevat profiilit ja ota yhteyttä tukeen ennen luonnin toistamista; tyhjä documents-luettelo ei todista, ettei ylävirtaan luotu mitään.