Ontwikkelaars

GET/v3/get_proof_types

Bewijscategorieën opvragen

Zoek de ID's van bewijscategorieën en de entiteitstypen op voordat u bewijsstukken voor identiteit of adres voorbereidt.

Op deze pagina
  1. Kies een bewijscategorie
  2. Houd rekening met de toepasselijke vereisten
  3. Verzoek
  4. Antwoord
  5. Fouten
  6. Beschikbaarheid en neveneffecten

Kies een bewijscategorie

Gebruik de geretourneerde categorie en het entiteitstype bij het voorbereiden van de bewijsstukken die voor een identiteit vereist zijn. Deze lijst beschrijft categorieën, niet uw geüploade bestanden, en houdt geen goedkeuring van bewijsstukken in.

Houd rekening met de toepasselijke vereisten

Dat een categorie in de lijst staat, betekent niet dat deze voldoet aan de vereisten voor elk land, elk nummertype of elke klantidentiteit. Lees de toepasselijke vereisten voordat u bewijsstukken uploadt en behandel geretourneerde ID's als ondoorzichtige waarden.

Verzoek

Gebruik de inloggegevens van uw ingeschakelde API-account via HTTPS. Basisauthenticatie en ingeschakelde bearertokens voor het API-account worden ondersteund; accountbeperkingen zijn van toepassing.

GET met een eventuele gedocumenteerde parameter in het URL-pad.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

Antwoord

Controleer status.code in de JSON-inhoud en ook de HTTP-status. response is een array van objecten met de velden id, name en entity_type. Deze waarden komen uit de huidige bewijscatalogus. ID's zijn ondoorzichtig; kopieer ze in plaats van zelf een ID samen te stellen of via hashing te berekenen. Ook een lege catalogus kan met succes worden geretourneerd. Leg op basis van dit voorbeeld geen volledige opsomming van entiteitstypen vast in de code.

Voorbeeld van de antwoordstructuur; dit zijn geen actuele accountgegevens en geen geldende prijsopgave.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

Fouten

  • Controleer status.code en status.msg op authenticatie- of servicefouten. Een succesvol antwoord met een lege catalogus houdt geen goedkeuring van een document of vrijstelling van registratie in.

Beschikbaarheid en neveneffecten

  • Met deze opvraagactie voor de catalogus of vereisten wordt geen identiteit aangemaakt, geen bewijsstuk geüpload, geen nummer geregistreerd en geen bestelling geplaatst.
  • Een succesvol catalogusantwoord houdt geen goedkeuring van uw documenten in en bevestigt niet dat een geselecteerd nummer kan worden geactiveerd.