Velg en dokumentasjonskategori
Bruk den returnerte kategorien og enhetstypen når du klargjør dokumentasjonen som kreves for en identitet. Denne listen beskriver kategorier, ikke filene du har lastet opp, og innebærer ingen godkjenning av dokumentasjon.
Følg de gjeldende kravene
At en kategori er oppført, betyr ikke at den oppfyller kravene for alle land, nummertyper eller kundeidentiteter. Les de gjeldende kravene før du laster opp dokumentasjon, og behandle returnerte ID-er som verdier som skal brukes uendret uten å tolke innholdet.
Forespørsel
Bruk påloggingsopplysningene til den aktiverte API-kontoen din over HTTPS. Grunnleggende autentisering og aktiverte bearer-tokener for API-kontoen støttes; kontobegrensninger gjelder.
GET med en eventuell dokumentert parameter i URL-stien.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_proof_types"Svar
Kontroller status.code i JSON-innholdet i tillegg til HTTP-statusen. response er en liste med objekter som inneholder id, name og entity_type. Disse verdiene kommer fra den gjeldende dokumentasjonskatalogen. ID-er skal ikke tolkes; kopier dem i stedet for å konstruere dem eller lage dem ved hjelp av hashing. En tom katalog kan returneres i et vellykket svar. Ikke hardkod et fullstendig sett med mulige enhetstyper ut fra dette eksemplet.
Illustrasjon av svarstrukturen; dette er ikke sanntidsdata fra en konto eller et gjeldende pristilbud.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"id": "PROOF_TYPE_ID_FROM_RESPONSE",
"name": "Example proof category",
"entity_type": "ENTITY_TYPE_FROM_RESPONSE"
}
]
}Feil
- Kontroller status.code og status.msg for autentiseringsfeil eller tjenestefeil. Et vellykket svar med en tom katalog innebærer verken godkjenning av et dokument eller fritak fra registrering.
Tilgjengelighet og sideeffekter
- Dette oppslaget i katalogen eller kravene oppretter ikke en identitet, laster ikke opp dokumentasjon, registrerer ikke et nummer og legger ikke inn en bestilling.
- Et vellykket katalogsvar innebærer verken godkjenning av dokumentene dine eller bekreftelse på at et valgt nummer kan aktiveres.