Legg ved et støttedokument

Legg ved et støttedokument basert på en mal

Bruk en mal fra get_supporting_document_templates og en identitet som allerede tilhører kontoen din. Last opp filene til dokumentet via create_encrypt_files med supporting_template_id. Vanlige opplastinger av identitets- eller adressebevis tilhører en annen kategori og kan ikke brukes som erstatning.

Opprett støttedokumentet

Bruk en aktivert konto for MultiTEL API og den tillatte IP-adressen for kontoen. Eksemplene bruker påloggingsopplysninger for HTTP Basic fra miljøvariabler; følg autentiseringsreglene for kontotypen din. Send forespørsler over HTTPS. Kontroller både svaret fra HTTP og verdien i JSON-feltet status.code; applikasjonsfeil kan komme med HTTP 200. Eksemplene nedenfor er oppdiktede.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

Felt i forespørselen
Felt	Betydning
`identity_id`	Obligatorisk ID for identiteten som er knyttet til kontoen din. Denne forespørselen knytter dokumentet til en identitet, ikke direkte til en adresse eller et telefonnummer.
`template_id`	Obligatorisk ID for malen for støttedokumentet; bruk den samme valgte malen som ved opplastingen av støttefilene. Feltet for vedlegging er template_id, mens feltet for opplasting er supporting_template_id.
`encrypted_file_ids`	Obligatorisk, ikke-tom liste i JSON med returnerte ID-er for opplastede filer. Hver fil må tilhøre den gjeldende kontoen, ha en filreferanse som ikke er utløpt, og tilhøre kategorien supporting_documents.

Skjemadata med gjentatte encrypted_file_ids[]-felt godtas også. Ikke send filinnhold i form av byte til dette endepunktet for vedlegging.

Opprettet støttedokument

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Dette bekrefter at støttedokumentet er opprettet, ikke at det er godkjent av en tilsynsmyndighet eller at nummeret er aktivert. Betegnelsen «permanent» i den underliggende kilderessursen gir ikke kunden noen garanti om lagringstid eller retningslinjer for sletting.

Feil og nye forsøk

API-kode 500 angir manglende inndata, operatørfeil eller et ugyldig svar fra operatøren. Kode 404 angir en identitet som ikke er knyttet til kontoen, en ugyldig mal, opplastede filer som mangler, er utløpt eller tilhører feil kategori, eller et tomt sett med brukbare filer. Kontroller status.msg; HTTP 200 alene er ikke tilstrekkelig.

Last opp og legg ved filene innenfor den returnerte gyldighetsperioden for filreferansene. Hvis svaret gir et uklart resultat, kontroller identitetens støttedokumenter i portalen før du prøver igjen. Denne behandlingsfunksjonen gjør ingen idempotensnøkkel tilgjengelig.