Fejlesztők

POST/v3/create_document

Regisztrációs profil létrehozása

Hozzon létre egy személyazonossági/címprofilt, és őrizze meg annak külön profil- és entitásazonosítóit.

Ezen az oldalon
  1. Hozza létre a profilt egyszer
  2. Létrehozási kérés
  3. Őrizze meg mind a három azonosítót
  4. Haladó: előre feltöltött igazolások csatolása létrehozáskor
  5. Hibák és részleges létrehozás

Hozza létre a profilt egyszer

Ez a kérés helyi regisztrációs profilt hoz létre a szolgáltatói személyazonossági és címrekordokkal együtt. Kiindulásként tekintse át az aktuális regisztrációs országok, számtípusok és követelmények listáját. A követelmények a regisztrálni kívánt ország és számtípus szerint eltérnek.

A sikeres létrehozási válasz nem jelent hatósági jóváhagyást vagy számaktiválást. Mentse el külön a dokumentum UUID-jét, a személyazonosság-azonosítót és a címazonosítót: különböző célokat szolgálnak. Ez a kérés módosítja a fiókadatokat, és nem csupán ellenőrzési művelet.

Létrehozási kérés

Hitelesítsen az engedélyezett MultiTEL API-fiókjával és annak engedélyezett IP-címéről. A példák környezeti változókban tárolt HTTP Basic hitelesítő adatokat használnak. Ellenőrizze a HTTP-választ és a JSON status.code értékét is; önmagában a HTTP 200 válasz nem igazolja a sikert. Minden példaérték kitalált.

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

A JSON egy szemléltető Personal profil, nem beküldésre kész valódi személyazonosság. Cserélje le az adatait és az aláírást a kiválasztott regisztrációs szabályok által megkövetelt végfelhasználói adatokra. Az űrlapkódolt bemenet is támogatott.

Regisztrációs profil mezői
MezőKötelezőség és formátum
identity_typeKötelező. Pontosan a Personal vagy Business értéket használja; a feltételes ellenőrzés a kis- és nagybetűk írásmódjától függ.
first_name, last_nameKötelező, egyenként legfeljebb 64 karakter. Vállalkozás esetén adja meg a kiválasztott ország által megkövetelt képviselői adatokat.
phone_numberKötelező numerikus telefonszám-érték, legalább nyolc karakter. Egy csak számjegyekből álló, az országkódot is tartalmazó nemzetközi szám megfelel ennek az ellenőrzésnek; ez kapcsolattartási szám, nem számvásárlás.
city, postal_code, addressKötelező, egyenként legfeljebb 64 karakter.
countryKötelező, a regisztrációs katalógusból származó, a cím szerinti ország ISO-kódja. A szolgáltatás ezt a szolgáltatói országrekordra oldja fel.
signatureKötelező aláírásadat. A jelenlegi portál Base64 PNG képbájtokat ad át a data:image/png;base64, előtag nélkül. A végfelhasználó aláírását az engedélyezett munkafolyamatán keresztül szerezze be; egy nem üres helyőrző nem minősül érdemi aláírásnak.
nationalityPersonal esetén kötelező, ország ISO-kódként. Ne helyettesítse ország-UUID-vel.
company_name, incorporation_countryBusiness esetén kötelező. A cégnév legfeljebb 64 karakter; az incorporation_country egy ország ISO-kódja.
emailOpcionális végfelhasználói kapcsolattartási e-mail, legfeljebb 254 karakter. A kihagyott vagy üres e-mail nem örökli az alapfiók e-mail-címét.
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, descriptionEbben a kezelőben opcionálisak, de a kiválasztott ország/szolgáltató némelyiküket megkövetelheti. Az adott regisztrációhoz szükséges formátumokat adja meg. A közvetlen API-hívások nem alkalmazzák automatikusan a portál által végzett összes normalizálást.

Ez a közvetlen v3 kezelő címmezőket igényel, és címet hoz létre. Ne feltételezze, hogy a portál címhalasztási lehetősége ezen keresztül elérhető.

Őrizze meg mind a három azonosítót

Az alábbi csak válogatott válaszmezőket mutat; a tényleges válasz a beküldött profiladatokat és az aláírásadatot is tartalmazza. A teljes választ bizalmasan kezelje.

{
  "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 a helyi profilt azonosítja. Használja a get_document hívással. A documents és get_document válaszaiban ugyanez a profilazonosító id néven szerepel.
  • response.identity_id a személyazonosságot azonosítja a későbbi személyazonossági igazolások és igazoló dokumentumok számára.
  • response.address_id a létrehozott címet azonosítja. Őrizze meg külön; a helyi profil UUID-je nem címazonosító. Az újonnan létrehozott profilok későbbi címigazolás-csatolási kompatibilitása még felülvizsgálat alatt áll.

A két profil-visszaolvasási végpont nem adja vissza az identity_id vagy address_id értéket, ezért őrizze meg az eredeti sikeres létrehozási választ. Ha elveszett, használja a portál dokumentumnézetét, vagy forduljon az ügyfélszolgálathoz, mielőtt helyettesítő profilt hozna létre.

Haladó: előre feltöltött igazolások csatolása létrehozáskor

Megadhatja az identity_encryptfiles és address_encryptfiles mezőket a create_encrypt_files által visszaadott azonosítók tömbjeként. A feltöltéshez a megfelelő entitáskategóriához tartozó igazolástípust használja, majd küldje be a nagyjából 20 perces fájlhivatkozás-lejárat előtt. A létrehozási kezelő minden megadott hivatkozásnál ellenőrzi a fiókot, a kategóriát és a lejáratot.

Ezek a mezők eltérő nevet viselnek, mint a későbbi csatolási végpont encrypted_file_ids mezője. Létrehozáskor minden fájl külön igazolási kérésként kerül elküldésre, akkor is, ha több fájl ugyanazt az igazolástípust használja. Olyan személyazonossági igazoláshoz, amelynek több fájlt kell együtt tartalmaznia, használja a későbbi create_proof kérést egyetlen tömbbel. A sikeres profil-létrehozás önmagában nem ad egyedi igazolás-jóváhagyási eredményeket.

Ha egy későbbi címigazolást elutasítanak egy újonnan létrehozott címnél, ne helyettesítse a profil UUID-jével, és ne hozza létre ismételten a személyazonosságot. Álljon meg, és ellenőrizze a profilt a portálon vagy az ügyfélszolgálattal. A címigazolás visszaolvasási/keresési útvonala továbbra is felülvizsgálati korlátozás.

Hibák és részleges létrehozás

A 400-as API-kód a mezőellenőrzési hibákat, a szolgáltatói létrehozási hibákat és a helyi mentési hibákat fedi le. Az ellenőrzési hibák mezőnként kulcsolt bejegyzésekként jelenhetnek meg a response részben. Az 500-as kód nem elérhető/érvénytelen regisztrációs ország esetén, a 404-es kód pedig hiányzó vagy lejárt előre feltöltött hivatkozások esetén használatos. A kód mellett olvassa el a status.msg értékét is.

A helyi profil és a felsőbb szintű szolgáltatói műveletek nem egyetlen atomi tranzakciót alkotnak. Egy sikertelen kérés akkor is hagyhat hátra felsőbb szintű állapotot, ha helyi profil nem szerepel a listában. Ügyféloldali idempotenciakulcs nem áll rendelkezésre. Időtúllépés vagy bizonytalan hiba után vizsgálja meg a meglévő profilokat, és forduljon az ügyfélszolgálathoz a létrehozás megismétlése előtt; az üres documents lista nem bizonyítja, hogy felsőbb szinten semmi sem jött létre.