Dołącz dokument uzupełniający

Dołącz dokument uzupełniający oparty na szablonie

Użyj szablonu z get_supporting_document_templates oraz tożsamości, która już należy do Twojego konta. Prześlij jej pliki za pomocą create_encrypt_files, używając supporting_template_id. Zwykłe przesłane pliki potwierdzające tożsamość lub adres należą do innej kategorii i nie można ich użyć w zastępstwie.

Utwórz dokument uzupełniający

Użyj aktywnego konta API MultiTEL oraz dozwolonego dla niego adresu IP. Przykłady wykorzystują dane uwierzytelniające HTTP Basic ze zmiennych środowiskowych; stosuj zasady uwierzytelniania właściwe dla Twojego typu konta. Wysyłaj żądania przez HTTPS. Sprawdzaj zarówno odpowiedź HTTP, jak i następujące pole w obiekcie JSON: status.code; błędy aplikacji mogą być zwracane ze statusem HTTP 200. Poniższe przykłady są fikcyjne.

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

Pola żądania
Pole	Znaczenie
`identity_id`	Wymagany identyfikator tożsamości powiązanej z Twoim kontem. To żądanie dołącza dokument do tożsamości, a nie bezpośrednio do adresu lub numeru telefonu.
`template_id`	Wymagany identyfikator szablonu dokumentu uzupełniającego; użyj tego samego wybranego szablonu co przy przesyłaniu plików uzupełniających. Pole służące do dołączania to template_id, natomiast pole używane przy przesyłaniu to supporting_template_id.
`encrypted_file_ids`	Wymagana niepusta tablica JSON zawierająca zwrócone identyfikatory przesłanych plików. Każdy przesłany plik musi należeć do bieżącego konta, mieć niewygasły okres ważności i należeć do kategorii supporting_documents.

Dane formularza z powtarzającymi się polami encrypted_file_ids[] są również akceptowane. Nie wysyłaj bajtów pliku do tego punktu końcowego służącego do dołączania.

Utworzony dokument uzupełniający

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

Potwierdza to utworzenie dokumentu uzupełniającego, a nie zatwierdzenie przez organ regulacyjny ani aktywację numeru. Określenie „trwały” w zasobie nadrzędnym nie stanowi gwarancji dla klienta dotyczącej okresu przechowywania ani zasad usuwania.

Błędy i ponawianie żądań

Kod API 500 oznacza brak danych wejściowych, błędy operatora lub nieprawidłową odpowiedź operatora. Kod 404 oznacza tożsamość niepowiązaną z kontem, nieprawidłowy szablon, brak przesłanych plików, wygaśnięcie ich ważności, niewłaściwą kategorię plików lub pusty zbiór plików nadających się do użycia. Sprawdź status.msg; sam status HTTP 200 nie wystarcza.

Prześlij i dołącz pliki w zwróconym okresie ważności odwołań do plików. Jeśli odpowiedź nie daje pewności co do wyniku, przed ponowieniem żądania sprawdź w portalu dokumenty uzupełniające danej tożsamości. Ta procedura obsługi nie udostępnia klucza idempotencji.