Opret en registreringsprofil

Opret profilen én gang

Denne forespørgsel opretter en lokal registreringsprofil sammen med identitets- og adresseposter hos operatøren. Begynd med de aktuelle registreringslande, nummertyper og krav. Kravene afhænger af det land og den nummertype, du planlægger at registrere.

Et vellykket oprettelsessvar er hverken en myndighedsgodkendelse eller en nummeraktivering. Gem dokumentets UUID, identitets-id og adresse-id hver for sig: de tjener forskellige formål. Denne forespørgsel ændrer kontodata og er ikke en operation, der kun validerer.

Oprettelsesforespørgsel

Godkend dig med din aktiverede MultiTEL API-konto og dens tilladte IP-adresse. Eksemplerne bruger HTTP Basic-legitimationsoplysninger, der er gemt i miljøvariabler. Kontrollér både HTTP-svaret og JSON-feltet status.code; et HTTP 200-svar alene er ikke bevis for succes. Alle eksempelværdier 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 illustrativ Personal-profil, ikke en reel identitet, der er klar til indsendelse. Erstat dens oplysninger og signatur med de slutbrugeroplysninger, som de valgte registreringsregler kræver. Formularkodet input understøttes også.

Felter i registreringsprofilen
Felt	Påkrævet og format
`identity_type`	Påkrævet. Brug den nøjagtige værdi Personal eller Business; den betingede validering afhænger af store og små bogstaver.
`first_name, last_name`	Påkrævet, hver højst 64 tegn. For en virksomhed angives de oplysninger om repræsentanten, som det valgte land kræver.
`phone_number`	Påkrævet numerisk telefonværdi på mindst otte tegn. Et internationalt nummer udelukkende med cifre og inklusive landekode egner sig til denne validering; dette er et kontaktnummer, ikke et nummerkøb.
`city, postal_code, address`	Påkrævet, hver højst 64 tegn.
`country`	Påkrævet ISO-kode for adresselandet fra registreringskataloget. Tjenesten omsætter den til operatørens landepost.
`signature`	Påkrævede signaturdata. Den nuværende portal leverer Base64-kodede PNG-billedbytes uden præfikset data:image/png;base64,. Indhent slutbrugerens signatur gennem din autoriserede arbejdsgang; en ikke-tom pladsholder er ikke en meningsfuld signatur.
`nationality`	Påkrævet for Personal, som en ISO-landekode. Brug ikke et lande-UUID i stedet.
`company_name, incorporation_country`	Påkrævet for Business. Virksomhedsnavnet må højst være 64 tegn; incorporation_country er en ISO-landekode.
`email`	Valgfri kontakt-e-mail for slutbrugeren, højst 254 tegn. En udeladt eller tom e-mail arver ikke basiskontoens e-mail.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Valgfrie i denne handler, men det valgte land/den valgte operatør kan kræve nogle af dem. Angiv de formater, som den pågældende registrering kræver. Direkte API-kald anvender ikke automatisk alle de normaliseringer, som portalen udfører.

Denne direkte v3-handler kræver adressefelter og opretter en adresse. Gå ikke ud fra, at portalens mulighed for at udskyde adressen er tilgængelig gennem den.

Gem alle tre identifikatorer

Det følgende viser udvalgte svarfelter; det faktiske svar indeholder også de indsendte profiloplysninger og signaturdata. Behandl hele svaret som fortroligt.

{
  "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 identificerer den lokale profil. Brug det sammen med get_document. I documents og get_document-svar hedder den samme profilidentifikator id.
response.identity_id identificerer identiteten til senere identitetsbeviser og understøttende dokumenter.
response.address_id identificerer den oprettede adresse. Gem det separat; den lokale profils UUID er ikke et adresse-id. Kompatibiliteten for senere vedhæftning af adressebeviser til nyoprettede profiler er stadig under gennemgang.

De to endpoints til udlæsning af profilen returnerer hverken identity_id eller address_id, så gem det oprindelige vellykkede oprettelsessvar. Hvis det er gået tabt, skal du bruge portalens dokumentvisning eller kontakte support, før du opretter en erstatning.

Avanceret: vedhæft forhåndsuploadede beviser under oprettelsen

Du kan angive identity_encryptfiles og address_encryptfiles som arrays af id'er returneret af create_encrypt_files. Upload med en bevistype for den tilsvarende enhedskategori, og indsend derefter, inden filreferencen udløber efter cirka 20 minutter. Oprettelseshandleren kontrollerer konto, kategori og udløb for hver angivet reference.

Disse felter har andre navne end det senere vedhæftningsendpoints encrypted_file_ids. Under oprettelsen sendes hver fil som en separat bevisforespørgsel, selv når flere filer deler én bevistype. For et identitetsbevis, der skal indeholde flere filer samlet, skal du bruge den senere create_proof-forespørgsel med ét array. En vellykket profiloprettelse alene giver ikke individuelle godkendelsesresultater for beviserne.

Hvis et senere adressebevis afvises for en nyoprettet adresse, må du ikke bruge profilens UUID i stedet eller genoprette identiteten gentagne gange. Stop, og kontrollér profilen i portalen eller hos support. Stien til udlæsning/opslag af adressebeviser er fortsat en begrænsning i gennemgangen.

Fejl og delvis oprettelse

API-kode 400 dækker feltvalidering, fejl ved oprettelse hos operatøren og fejl ved lokal lagring. Valideringsfejl kan optræde som feltnøglede poster i response. Kode 500 bruges til et utilgængeligt/ugyldigt registreringsland, og kode 404 til manglende eller udløbne forhåndsuploadede referencer. Læs status.msg såvel som koden.

Den lokale profil og operationerne hos den opstrøms operatør udgør ikke én atomisk transaktion. En mislykket forespørgsel kan efterlade tilstand opstrøms, selv når ingen lokal profil er opført. Der eksponeres ingen idempotensnøgle for klienten. Efter en timeout eller en usikker fejl skal du undersøge de eksisterende profiler og kontakte support, før du gentager oprettelsen; en tom documents-liste er ikke bevis for, at intet blev oprettet opstrøms.