Skep 'n registrasieprofiel

Skep die profiel een keer

Hierdie versoek skep 'n plaaslike registrasieprofiel saam met die draer se identiteits- en adresrekords. Begin met die huidige registrasielande, nommertipes en vereistes. Vereistes hang af van die land en die tipe nommer wat jy beplan om te registreer.

'n Suksesvolle skep-antwoord is nie regulatoriese goedkeuring of nommeraktivering nie. Stoor die dokument-UUID, identiteits-ID en adres-ID afsonderlik: hulle dien verskillende doeleindes. Hierdie versoek verander rekeningdata en is nie 'n slegs-validering-bewerking nie.

Skep-versoek

Verifieer met jou geaktiveerde MultiTEL API-rekening en sy toegelate IP-adres. Die voorbeelde gebruik HTTP Basic-geloofsbriewe wat in omgewingsveranderlikes gestoor is. Kontroleer sowel die HTTP-antwoord as die JSON-veld status.code; 'n HTTP 200-antwoord alleen bewys nie sukses nie. Alle voorbeeldwaardes is fiktief.

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

Die JSON is 'n illustratiewe Personal-profiel, nie 'n werklike identiteit wat gereed is om ingedien te word nie. Vervang sy besonderhede en handtekening met die eindgebruikerinligting wat deur die gekose registrasiereëls vereis word. Vorm-geënkodeerde invoer word ook ondersteun.

Registrasieprofielvelde
Veld	Vereis en formaat
`identity_type`	Vereis. Gebruik die presiese waarde Personal of Business; voorwaardelike validering hang van hoofletters af.
`first_name, last_name`	Vereis, elk hoogstens 64 karakters. Vir 'n besigheid, verskaf die verteenwoordigerbesonderhede wat deur die gekose land vereis word.
`phone_number`	Vereiste numeriese telefoonwaarde, minstens agt karakters. 'n Internasionale nommer met slegs syfers, insluitend sy landkode, is geskik vir hierdie validering; dit is 'n kontaknommer, nie 'n nommeraankoop nie.
`city, postal_code, address`	Vereis, elk hoogstens 64 karakters.
`country`	Vereiste ISO-kode van die adresland uit die registrasiekatalogus. Die diens los dit op na die draer se landrekord.
`signature`	Vereiste handtekeningdata. Die huidige portaal verskaf Base64 PNG-beeldgrepe sonder die data:image/png;base64,-voorvoegsel. Verkry die eindgebruiker se handtekening deur jou gemagtigde werkvloei; 'n nie-leë plekhouer is nie 'n betekenisvolle handtekening nie.
`nationality`	Vereis vir Personal, as 'n land-ISO-kode. Moenie 'n land-UUID in die plek daarvan gebruik nie.
`company_name, incorporation_country`	Vereis vir Business. Die maatskappynaam is hoogstens 64 karakters; incorporation_country is 'n land-ISO-kode.
`email`	Opsionele kontak-e-posadres van die eindgebruiker, hoogstens 254 karakters. 'n Weggelate of leë e-posadres erf nie die basisrekening se e-posadres nie.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	Opsioneel in hierdie hanteerder, maar die gekose land/draer kan sommige daarvan vereis. Verskaf die formate wat vir daardie registrasie vereis word. Direkte API-oproepe pas nie outomaties elke normalisering toe wat die portaal uitvoer nie.

Hierdie direkte v3-hanteerder vereis adresvelde en skep 'n adres. Moenie aanneem dat die portaal se opsie om die adres uit te stel daardeur beskikbaar is nie.

Bewaar al drie identifiseerders

Die volgende toon geselekteerde antwoordvelde; die werklike antwoord bevat ook die ingediende profielinligting en handtekeningdata. Hanteer die volledige antwoord as privaat.

{
  "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 identifiseer die plaaslike profiel. Gebruik dit met get_document. In documents en get_document-antwoorde het dieselfde profielidentifiseerder die naam id.
response.identity_id identifiseer die identiteit vir latere identiteitsbewyse en ondersteunende dokumente.
response.address_id identifiseer die geskepte adres. Bewaar dit afsonderlik; die plaaslike profiel-UUID is nie 'n adres-ID nie. Die latere versoenbaarheid van adresbewys-aanhegting vir nuut geskepte profiele word nog hersien.

Die twee profiel-terugleeseindpunte gee nie identity_id of address_id terug nie, bewaar dus die oorspronklike suksesvolle skep-antwoord. As dit verlore gegaan het, gebruik die portaal se dokumentaansig of kontak ondersteuning voordat jy 'n vervanging skep.

Gevorderd: heg vooraf opgelaaide bewyse tydens skepping aan

Jy kan identity_encryptfiles en address_encryptfiles verskaf as skikkings van ID's wat deur create_encrypt_files teruggegee word. Laai op met 'n bewystipe vir die ooreenstemmende entiteitskategorie en dien dan in voordat die lêerverwysing na ongeveer 20 minute verval. Die skep-hanteerder kontroleer die rekening, kategorie en vervaldatum van elke verskafte verwysing.

Hierdie velde het ander name as die latere aanhegtingseindpunt se encrypted_file_ids. Tydens skepping word elke lêer as 'n afsonderlike bewysversoek gestuur, selfs wanneer verskeie lêers een bewystipe deel. Vir 'n identiteitsbewys wat verskeie lêers saam moet bevat, gebruik die latere create_proof-versoek met een skikking. Suksesvolle profielskepping alleen verskaf nie individuele bewysgoedkeuringsresultate nie.

As 'n latere adresbewys vir 'n nuut geskepte adres verwerp word, moenie die profiel-UUID in die plek daarvan gebruik of die identiteit herhaaldelik herskep nie. Stop en kontroleer die profiel in die portaal of by ondersteuning. Die teruglees-/opsoekpad vir adresbewyse bly 'n hersieningsbeperking.

Mislukkings en gedeeltelike skepping

API-kode 400 dek veldvalidering, mislukkings by die draer se skepping en plaaslike stoormislukkings. Valideringsfoute kan as veldgesleutelde inskrywings in response verskyn. Kode 500 word gebruik vir 'n onbeskikbare/ongeldige registrasieland, en kode 404 vir ontbrekende of vervalde vooraf opgelaaide verwysings. Lees status.msg sowel as die kode.

Die plaaslike profiel en die stroomop-draerbewerkings is nie een atomiese transaksie nie. 'n Mislukte versoek kan stroomop-toestand agterlaat selfs wanneer geen plaaslike profiel gelys word nie. Geen kliënt-idempotensiesleutel word blootgestel nie. Na 'n uittelling of onsekere mislukking, inspekteer bestaande profiele en kontak ondersteuning voordat jy die skepping herhaal; 'n leë documents-lys is nie bewys dat niks stroomop geskep is nie.