Opprett en registreringsprofil

Opprett profilen én gang

Denne forespørselen oppretter en lokal registreringsprofil sammen med identitets- og adresseoppføringer hos operatøren. Begynn med de gjeldende registreringslandene, nummertypene og kravene. Kravene avhenger av landet og typen nummer du planlegger å registrere.

Et vellykket opprettelsessvar er ikke en regulatorisk godkjenning eller en nummeraktivering. Lagre dokument-UUID-en, identitets-ID-en og adresse-ID-en hver for seg: de tjener ulike formål. Denne forespørselen endrer kontodata og er ikke en operasjon kun for validering.

Opprettelsesforespørsel

Autentiser med din aktiverte MultiTEL API-konto og dens tillatte IP-adresse. Eksemplene bruker HTTP Basic-legitimasjon lagret i miljøvariabler. Kontroller både HTTP-svaret og JSON-feltet status.code; et HTTP 200-svar alene bekrefter ikke at forespørselen lyktes. Alle eksempelverdier er fiktive.

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-en er en illustrerende Personal-profil, ikke en ekte identitet som er klar til innsending. Erstatt detaljene og signaturen med sluttbrukerinformasjonen som kreves av de valgte registreringsreglene. Skjemakodet inndata støttes også.

Felt i registreringsprofilen
Felt	Påkrevd og format
`identity_type`	Påkrevd. Bruk den nøyaktige verdien Personal eller Business; betinget validering avhenger av store og små bokstaver.
`first_name, last_name`	Påkrevd, hvert på høyst 64 tegn. For en bedrift oppgir du representantopplysningene som kreves av det valgte landet.
`phone_number`	Påkrevd numerisk telefonverdi på minst åtte tegn. Et internasjonalt nummer med bare sifre, inkludert landskoden, egner seg for denne valideringen; dette er et kontaktnummer, ikke et nummerkjøp.
`city, postal_code, address`	Påkrevd, hvert på høyst 64 tegn.
`country`	Påkrevd ISO-kode for adresselandet fra registreringskatalogen. Tjenesten løser den opp til operatørens landoppføring.
`signature`	Påkrevde signaturdata. Den gjeldende portalen leverer Base64-kodede PNG-bildebyte uten prefikset data:image/png;base64,. Innhent sluttbrukerens signatur gjennom din autoriserte arbeidsflyt; en ikke-tom plassholder er ikke en meningsfull signatur.
`nationality`	Påkrevd for Personal, som en ISO-landskode. Ikke erstatt den med en land-UUID.
`company_name, incorporation_country`	Påkrevd for Business. Firmanavnet er på høyst 64 tegn; incorporation_country er en ISO-landskode.
`email`	Valgfri kontakt-e-post for sluttbrukeren, høyst 254 tegn. Utelatt eller tom e-post arver ikke basiskontoens e-post.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Valgfrie i denne behandleren, men det valgte landet/operatøren kan kreve noen av dem. Oppgi formatene som kreves for den registreringen. Direkte API-kall bruker ikke automatisk all normalisering som portalen utfører.

Denne direkte v3-behandleren krever adressefelt og oppretter en adresse. Ikke anta at portalens alternativ for å utsette adressen er tilgjengelig gjennom den.

Ta vare på alle tre identifikatorene

Det følgende viser utvalgte svarfelt; det faktiske svaret inneholder også innsendt profilinformasjon og signaturdata. Behandle hele svaret som 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 identifiserer den lokale profilen. Bruk den med get_document. I svar fra documents og get_document har den samme profilidentifikatoren navnet id.
response.identity_id identifiserer identiteten for senere identitetsbevis og støttedokumenter.
response.address_id identifiserer den opprettede adressen. Oppbevar den separat; den lokale profil-UUID-en er ikke en adresse-ID. Kompatibilitet for senere vedlegg av adressebevis for nyopprettede profiler er fortsatt under gjennomgang.

De to endepunktene for tilbakelesing av profilen returnerer ikke identity_id eller address_id, så ta vare på det opprinnelige vellykkede opprettelsessvaret. Hvis det har gått tapt, bruker du portalens dokumentvisning eller kontakter kundestøtte før du oppretter en erstatning.

Avansert: legg ved forhåndsopplastede bevis under opprettelsen

Du kan oppgi identity_encryptfiles og address_encryptfiles som matriser med ID-er returnert av create_encrypt_files. Last opp med en bevistype for den tilsvarende enhetskategorien, og send deretter inn før filreferansen utløper etter omtrent 20 minutter. Opprettelsesbehandleren kontrollerer kontoen, kategorien og utløpet for hver oppgitt referanse.

Disse feltene har andre navn enn det senere vedleggsendepunktets encrypted_file_ids. Under opprettelsen sendes hver fil som en separat bevisforespørsel, selv når flere filer deler én bevistype. For et identitetsbevis som må inneholde flere filer samlet, bruker du den senere create_proof-forespørselen med én matrise. Vellykket profilopprettelse alene gir ingen resultater for godkjenning av enkeltbevis.

Hvis et senere adressebevis avvises for en nyopprettet adresse, må du ikke erstatte den med profil-UUID-en eller opprette identiteten på nytt gjentatte ganger. Stopp og kontroller profilen i portalen eller med kundestøtte. Banen for tilbakelesing/oppslag av adressebevis er fortsatt en begrensning i gjennomgangen.

Feil og delvis opprettelse

API-kode 400 dekker feltvalidering, feil ved opprettelse hos operatøren og feil ved lokal lagring. Valideringsfeil kan vises som feltnøklede oppføringer i response. Kode 500 brukes for et utilgjengelig/ugyldig registreringsland, og kode 404 for manglende eller utløpte forhåndsopplastede referanser. Les status.msg i tillegg til koden.

Den lokale profilen og operasjonene hos oppstrømsoperatøren er ikke én atomisk transaksjon. En mislykket forespørsel kan etterlate tilstand oppstrøms selv når ingen lokal profil er oppført. Ingen idempotensnøkkel for klienten er eksponert. Etter et tidsavbrudd eller en usikker feil må du undersøke eksisterende profiler og kontakte kundestøtte før du gjentar opprettelsen; en tom documents-liste er ikke bevis på at ingenting ble opprettet oppstrøms.