Liitä täydentävä asiakirja

Liitä mallipohjainen täydentävä asiakirja

Käytä mallia, jonka tarjoaa get_supporting_document_templates, sekä henkilöllisyyttä, joka jo kuuluu tilillesi. Lataa asiakirjan tiedostot toiminnolla create_encrypt_files käyttäen kenttää supporting_template_id. Tavalliset henkilöllisyyden tai osoitteen todistavien asiakirjojen lataukset kuuluvat eri luokkaan, eikä niitä voi käyttää näiden sijasta.

Luo täydentävä asiakirja

Käytä käytössä olevaa MultiTEL API -tiliä ja sille sallittua IP-osoitetta. Esimerkeissä käytetään ympäristömuuttujista saatavia HTTP Basic -tunnuksia; noudata oman tilityyppisi todennuskäytäntöjä. Lähetä pyynnöt HTTPS-yhteydellä. Tarkista sekä HTTP-vastaus että JSON-kenttä status.code; sovellusvirheitä voidaan palauttaa myös HTTP 200 -vastauksessa. Alla olevat esimerkit ovat kuvitteellisia.

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

Pyynnön kentät
Kenttä	Merkitys
`identity_id`	Pakollinen tilillesi liitetyn henkilöllisyyden tunniste. Tämä pyyntö liittää asiakirjan henkilöllisyyteen, ei suoraan osoitteeseen tai puhelinnumeroon.
`template_id`	Pakollinen täydentävän asiakirjan mallin tunniste; käytä samaa valittua mallia kuin täydentävän asiakirjan latauksessa. Liittämisen kenttä on template_id, kun taas latauksen kenttä on supporting_template_id.
`encrypted_file_ids`	Pakollinen JSON-taulukko palautetuista lataustunnisteista; taulukko ei saa olla tyhjä. Jokaisen latauksen on kuuluttava nykyiselle tilille, oltava edelleen voimassa ja kuuluttava luokkaan supporting_documents.

Myös lomaketiedot, joissa on toistuvia encrypted_file_ids[]-kenttiä, hyväksytään. Älä lähetä tiedostojen tavusisältöä tähän liittämisen päätepisteeseen.

Luotu täydentävä asiakirja

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

Tämä vahvistaa täydentävän asiakirjan luomisen, ei sääntelyn mukaista hyväksyntää tai numeron aktivointia. Taustajärjestelmän resurssissa käytetty ilmaus pysyvä ei ole asiakkaalle annettu takuu säilytysajasta tai poistokäytännöstä.

Virheet ja uudelleenyritykset

API-koodi 500 tarkoittaa puuttuvia syötteitä, operaattorin virheitä tai virheellistä operaattorin vastausta. Koodi 404 tarkoittaa henkilöllisyyttä, jota ei ole liitetty tiliin, virheellistä mallia, puuttuvia, vanhentuneita tai väärään luokkaan kuuluvia latauksia taikka tyhjää käytettävissä olevien tiedostojen joukkoa. Tarkista status.msg; pelkkä HTTP 200 ei riitä.

Lataa ja liitä tiedostot palautetun tiedostoviitteen voimassaoloaikana. Jos vastaus on epäselvä, tarkista henkilöllisyyteen liitetyt täydentävät asiakirjat portaalista ennen uutta yritystä. Tämä käsittelijä ei tarjoa idempotenssiavainta.