Lys registrasieprofiele

Vind bestaande registrasieprofiele

Lys die aktiewe plaaslike registrasieprofiele wat aan jou API-rekening gekoppel is en nie uitgevee is nie. Gebruik dit om 'n profiel se UUID te vind voordat jy dit oopmaak met get_document, en nie om te bepaal of die bewysstukke of nommerregistrasie daarvan goedgekeur is nie.

Lysversoek

Staaf jou identiteit met jou geaktiveerde MultiTEL API-rekening en die toegelate IP-adres daarvan. Die voorbeelde gebruik HTTP Basic-aanmeldbesonderhede wat in omgewingsveranderlikes gestoor is. Gaan sowel die HTTP-respons as die JSON-veld na: status.code; 'n HTTP 200-respons op sigself bevestig nie sukses nie. Alle voorbeeldwaardes is fiktief.

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

Hierdie hanteerder implementeer geen versoekliggaam, paginering of filterparameters nie. Dit gee die ooreenstemmende rekening se gestoorde profiele terug; moenie 'n bepaalde volgorde aanneem nie. Vermy gereelde herhaalde navrae vir die volledige lys vir groot rekeninge.

Responslys

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

As daar geen ooreenstemmende aktiewe profiele is nie, gee die hanteerder API-kode 200 en 'n leë responslys terug. response[].id is die plaaslike profiel se UUID wat tydens skepping as uuid teruggegee word; dit is nie 'n identiteits-ID of adres-ID nie.

Profielvelde wat teruggegee word

Die geprojekteerde stel velde bevat 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 en date_created.

Opsionele waardes kan leeg of null wees, afhangend van die gestoorde data. Hierdie geprojekteerde stel velde uit die ouer stelsel laat email, landkeusevelde, identity_id, address_id, verwysings na opgelaaide lêers, lyste van bewysstukke en verifikasiestatus weg. Dit is nie 'n eindpunt vir die status van bewysstukke of die goedkeuring van registrasies nie. Hanteer die identiteits-, kontak- en handtekeningdata wat teruggegee word as privaat.

Volgende stappe

Stoor entiteits-ID's uit die oorspronklike create_document-respons vir latere aanhegtings. As daardie respons verlore geraak het, kan hierdie lys nie die ID's herwin nie. Bekyk die profiel in die portaal of kontak ondersteuning in plaas daarvan om outomaties 'n duplikaat te skep.