Kūrėjams

GET/v3/documents

Registracijos profilių sąrašo gavimas

Raskite aktyvius vietinius paskyros profilius naudodami ribotą senosios versijos laukų rinkinį.

Šiame puslapyje
  1. Esamų registracijos profilių paieška
  2. Sąrašo gavimo užklausa
  3. Atsakyme pateikiamas sąrašas
  4. Grąžinami profilio laukai
  5. Tolesni veiksmai

Esamų registracijos profilių paieška

Gaukite su jūsų API paskyra susietų aktyvių, neištrintų vietinių registracijos profilių sąrašą. Naudokite šią funkciją profilio UUID rasti prieš atverdami profilį naudodami get_document, o ne nustatyti, ar jo patvirtinamieji dokumentai arba numerio registracija buvo patvirtinti.

Sąrašo gavimo užklausa

Autentifikuokitės naudodami įgalintą „MultiTEL“ API paskyrą ir jai leidžiamą IP adresą. Pavyzdžiuose naudojami aplinkos kintamuosiuose saugomi HTTP Basic prisijungimo duomenys. Tikrinkite ir HTTP atsakymą, ir JSON lauką status.code; vien HTTP 200 atsakymas dar nereiškia, kad užklausa sėkminga. Visos pavyzdžių reikšmės yra išgalvotos.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/documents

Šis užklausų apdorojimo komponentas nepalaiko užklausos turinio, puslapiavimo ar filtravimo parametrų. Jis grąžina atitinkamos paskyros išsaugotus profilius; nesitikėkite konkrečios jų tvarkos. Jei paskyra didelė, venkite dažnai kartoti viso sąrašo gavimo užklausas.

Atsakyme pateikiamas sąrašas

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": [
    {
      "id": "11111111111111111111111111111111",
      "first_name": "Example",
      "last_name": "Person",
      "phone_number": "12025550123",
      "id_number": "",
      "birth_date": null,
      "company_name": "",
      "company_reg_number": "",
      "vat_id": "",
      "personal_tax_id": "",
      "description": "Example profile",
      "identity_type": "Personal",
      "postal_code": "00000",
      "city": "Example City",
      "address": "1 Example Street",
      "signature": "BASE64_PNG_SIGNATURE_DATA",
      "date_created": "2026-10-23 16:00:00"
    }
  ]
}

Jei nėra atitinkančių aktyvių profilių, užklausų apdorojimo komponentas grąžina API kodą 200 ir tuščią atsakymo sąrašą. response[].id yra vietinio profilio UUID, kuris kuriant grąžinamas kaip uuid; tai nėra tapatybės ID ar adreso ID.

Grąžinami profilio laukai

Grąžinamą laukų rinkinį sudaro id, first_name, last_name, phone_number, id_number, birth_date, company_name, company_reg_number, vat_id, personal_tax_id, description, identity_type, postal_code, city, address, signature ir date_created.

Atsižvelgiant į išsaugotus duomenis, neprivalomos reikšmės gali būti tuščios arba null. Į šį senosios versijos laukų rinkinį neįtraukiami email, šalies pasirinkimo laukai, identity_id, address_id, įkeltų failų nuorodos, patvirtinamųjų dokumentų sąrašai ir patikros būsena. Šis API galinis taškas nėra skirtas patvirtinamųjų dokumentų būsenai ar registracijos patvirtinimui nustatyti. Grąžinamus tapatybės, kontaktinius ir parašo duomenis laikykite privačiais.

Tolesni veiksmai

Išsaugokite objektų ID iš pradinio create_document atsakymo, kad vėliau galėtumėte susieti priedus. Jei šis atsakymas prarastas, iš šio sąrašo tų ID atkurti negalima. Peržiūrėkite profilį portale arba susisiekite su pagalbos tarnyba, užuot automatiškai kūrę dublikatą.