Kehittäjät

GET/v3/documents

Listaa rekisteröintiprofiilit

Etsi tilin aktiiviset paikalliset profiilit vanhan toteutuksen rajatun kenttävalikoiman avulla.

Tällä sivulla
  1. Etsi olemassa olevia rekisteröintiprofiileja
  2. Listauspyyntö
  3. Vastauslista
  4. Palautettavat profiilikentät
  5. Seuraavat vaiheet

Etsi olemassa olevia rekisteröintiprofiileja

Listaa API-tiliisi liittyvät aktiiviset paikalliset rekisteröintiprofiilit, joita ei ole poistettu. Käytä tätä profiilin UUID-tunnuksen etsimiseen ennen profiilin avaamista toiminnolla get_document, älä sen selvittämiseen, onko profiilin todistusasiakirjat tai numeron rekisteröinti hyväksytty.

Listauspyyntö

Tunnistaudu käytössä olevalla MultiTEL API -tililläsi ja sille sallitusta IP-osoitteesta. Esimerkeissä käytetään ympäristömuuttujiin tallennettuja HTTP Basic -tunnuksia. Tarkista sekä HTTP-vastaus että JSON-kenttä status.code; pelkkä HTTP 200 -vastaus ei osoita onnistumista. Kaikki esimerkkiarvot ovat kuvitteellisia.

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

Tämä käsittelijä ei tue pyynnön runkoa, sivutusta eikä suodatusparametreja. Se palauttaa vastaavan tilin tallennetut profiilit; älä oleta niiden olevan tietyssä järjestyksessä. Vältä koko listan tiheää kyselyä suurilla tileillä.

Vastauslista

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

Jos vastaavia aktiivisia profiileja ei ole, käsittelijä palauttaa API-koodin 200 ja tyhjän vastauslistan. response[].id on paikallisen profiilin UUID-tunnus, joka palautetaan luonnin yhteydessä kentässä uuid; se ei ole henkilöllisyyden eikä osoitteen tunnus.

Palautettavat profiilikentät

Kenttävalikoimaan kuuluvat 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 ja date_created.

Valinnaiset arvot voivat olla tyhjiä tai null tallennettujen tietojen mukaan. Tästä vanhan toteutuksen kenttävalikoimasta puuttuvat email, maavalitsimet, identity_id, address_id, ladattujen tiedostojen viitteet, todistusasiakirjojen listat ja varmennuksen tila. Tämä ei ole todistusasiakirjojen tilan tai rekisteröinnin hyväksynnän tarkistamiseen tarkoitettu päätepiste. Käsittele palautettuja henkilöllisyys-, yhteys- ja allekirjoitustietoja yksityisinä.

Seuraavat vaiheet

Tallenna tietueiden tunnukset alkuperäisestä create_document -vastauksesta myöhempiä liittämisiä varten. Jos kyseinen vastaus on kadonnut, tunnuksia ei voi palauttaa tämän listan avulla. Tarkastele profiilia palvelussa portaali tai ota yhteyttä tukeen sen sijaan, että loisit automaattisesti kaksoiskappaleen.