Tilknyt et supplerende dokument

Tilknyt et supplerende dokument baseret på en skabelon

Brug en skabelon fra get_supporting_document_templates og en identitet, som din konto allerede ejer. Upload dokumentets filer via create_encrypt_files med supporting_template_id. Almindelige uploads af identitets- eller adressebevis tilhører en anden kategori og kan ikke bruges som erstatning.

Opret det supplerende dokument

Brug en aktiveret MultiTEL API-konto og dens tilladte IP-adresse. Eksemplerne bruger legitimationsoplysninger til HTTP Basic fra miljøvariabler; følg godkendelsesreglerne for din kontotype. Send anmodninger via HTTPS. Kontrollér både HTTP-svaret og følgende felt i JSON-svaret: status.code; applikationsfejl kan forekomme med HTTP 200. Eksemplerne nedenfor er fiktive.

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

Anmodningsfelter
Felt	Betydning
`identity_id`	Påkrævet ID for den identitet, der er knyttet til din konto. Denne anmodning knytter dokumentet til en identitet, ikke direkte til en adresse eller et telefonnummer.
`template_id`	Påkrævet ID for skabelonen til det supplerende dokument; brug den samme valgte skabelon som ved uploaden af det supplerende dokument. Feltet til tilknytning er template_id, mens feltet til upload er supporting_template_id.
`encrypted_file_ids`	Påkrævet, ikke-tomt JSON-array med de returnerede upload-ID'er. Hver upload skal tilhøre den aktuelle konto, må ikke være udløbet og skal have kategorien supporting_documents.

Formulardata med gentagne encrypted_file_ids[]-felter accepteres også. Send ikke filernes byteindhold til dette endepunkt til dokumenttilknytning.

Oprettet supplerende dokument

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

Dette bekræfter oprettelsen af det supplerende dokument, ikke myndighedsgodkendelse eller aktivering af nummeret. Betegnelsen permanent i den bagvedliggende ressource er ikke en garanti til kunden om opbevaringstid eller sletningspolitik.

Fejl og nye forsøg

API-kode 500 angiver manglende input, fejl hos teleoperatøren eller et ugyldigt svar fra teleoperatøren. Kode 404 angiver en identitet, der ikke er knyttet til kontoen, en ugyldig skabelon, uploads, der mangler, er udløbet eller tilhører en forkert kategori, eller et tomt sæt af brugbare filer. Kontrollér status.msg; HTTP 200 er ikke tilstrækkeligt i sig selv.

Upload og tilknyt inden for gyldighedsperioden for den returnerede filreference. Hvis svaret er uklart, skal du kontrollere identitetens supplerende dokumenter i portalen, før du prøver igen. Denne anmodningshåndtering stiller ingen idempotensnøgle til rådighed.