Zastąp edytowalne dane profilu
Zaktualizuj istniejący profil rejestracyjny należący do konta, używając jego lokalnego identyfikatora UUID uzyskanego z create_document lub documents. Ta operacja zmienia dane konta oraz dane u operatora nadrzędnego. Nie zmienia zapisanego typu tożsamości Personal/Business i nie jest operacją PATCH aktualizującą tylko wybrane pola.
Żądanie aktualizacji
Uwierzytelnij się za pomocą aktywnego konta API MultiTEL z dozwolonego adresu IP. Przykłady korzystają z danych uwierzytelniających zapisanych w zmiennych środowiskowych oraz z fikcyjnych danych. Odczytaj pola JSON status.code i status.msg, a także odpowiedź HTTP.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @registration-profile-update.json \
"https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"{
"first_name": "Example",
"last_name": "Person",
"phone_number": "12025550123",
"email": "end-user@example.com",
"city": "Example City",
"postal_code": "00000",
"address": "1 Example Street",
"country": "US",
"nationality": "US",
"signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
"id_number": "",
"personal_tax_id": "",
"birth_date": "",
"description": "Example profile",
"company_name": "",
"company_reg_number": "",
"incorporation_country": "",
"vat_id": "",
"address_description": ""
}Przykład przedstawia profil typu Personal; zastąp dane przykładowe kompletnymi danymi docelowymi użytkownika końcowego oraz jego autoryzowanym podpisem. Nie przesyłaj podpisów zastępczych ani pustych wartości w celu zachowania danych. Obsługiwane są dane wejściowe w formacie JSON i dane kodowane jako formularz.
| Pola | Działanie |
|---|---|
| first_name, last_name, city, postal_code, address | Wymagane; każde pole może zawierać najwyżej 64 znaki. |
| phone_number | Wymagana wartość liczbowa o długości co najmniej ośmiu znaków; użyj cyfr w formacie międzynarodowym, uwzględniając kod kraju. |
| signature | Wymagane. Portal dostarcza bajty obrazu PNG zakodowane w Base64, bez prefiksu adresu URL danych. |
| country | Podaj kod ISO kraju adresu z katalogu rejestracyjnego. Procedura obsługi ustala na jego podstawie kraj, chociaż przeanalizowana aktualizacja adresu nie zmienia powiązania z krajem. |
| nationality | Kod ISO kraju wymagany dla istniejącego profilu typu Personal. |
| company_name, incorporation_country | Wymagane dla istniejącego profilu typu Business; nazwa firmy może zawierać najwyżej 64 znaki, a kraj rejestracji firmy należy podać jako kod ISO. |
| Opcjonalny poprawny adres e-mail o długości do 254 znaków. Pomiń pole, aby zachować zapisany kontaktowy adres e-mail; prześlij pustą wartość, aby usunąć go lokalnie. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Prześlij docelowe aktualne wartości. Pominięte wartości domyślnie są puste i mogą nadpisać istniejące zapisane wartości. |
Zasady rejestracji obowiązujące w danym kraju mogą wymagać dodatkowych informacji lub formatów. Nie odtwarzaj kompletnego zestawu danych do aktualizacji wyłącznie na podstawie get_document: ograniczona odpowiedź tej funkcji nie zawiera pól wyboru kraju, email ani identyfikatorów encji. Zachowaj dane źródłowe, do których używania masz uprawnienia, lub skorzystaj z edytora dokumentów w portalu.
Zaawansowane: dodawanie wcześniej przesłanych dokumentów potwierdzających
Opcjonalne tablice identity_encryptfiles i address_encryptfiles przyjmują aktywne odwołania należące do konta, uzyskane z create_encrypt_files. Dopasuj kategorię encji do kategorii przesłanego pliku i wyślij żądanie przed wygaśnięciem odwołania. Każdy plik jest dołączany w osobnym żądaniu dotyczącym dokumentu potwierdzającego, nawet jeśli kilka plików ma ten sam typ potwierdzenia. W przypadku wieloplikowego potwierdzenia tożsamości skorzystaj z późniejszego procesu dołączania dokumentów potwierdzających z użyciem jednej tablicy.
Jeśli późniejszy dowód adresu zostanie odrzucony dla nowo utworzonego adresu, nie podstawiaj UUID profilu ani nie twórz tożsamości wielokrotnie od nowa. Zatrzymaj się i sprawdź profil w portalu lub z pomocą techniczną. Ścieżka odczytu/wyszukiwania dowodów adresu pozostaje ograniczeniem przeglądu.
Odpowiedzi o powodzeniu i błędach w starszym formacie
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Standardowym kodem powodzenia tego punktu końcowego jest ciąg znaków success, a nie wartość liczbowa 200. Standardowy błąd w systemie nadrzędnym lub lokalnym może być oznaczony ciągiem znaków error. Kod liczbowy 400 oznacza nieprawidłowe pola lub błędy dotyczące dokumentów potwierdzających, 404 — brak profilu lub nieprawidłowe odwołanie do przesłanego pliku, a 500 — pustą treść żądania lub kraj, którego nie udało się ustalić. Odczytaj komunikat i wszelkie wpisy dotyczące walidacji; nie uznawaj samego kodu HTTP 200 za potwierdzenie powodzenia.
Aktualne ograniczenia aktualizacji i postępowanie po błędach
Zgłoszone powodzenie nie gwarantuje, że każde pole w systemie nadrzędnym zostało zmienione. Przeanalizowany kod może zapisać lokalny profil po nieudanej aktualizacji adresu w systemie nadrzędnym. Aktualizacja tożsamości w systemie nadrzędnym nie obejmuje email. Nie potwierdzono, że ta ścieżka obsługi zmienia kraj adresu lub synchronizuje opis adresu. Jeśli potrzebujesz tych zmian, sprawdź wynik w portalu i skontaktuj się z pomocą techniczną, zamiast zakładać, że rejestracja w systemie nadrzędnym została zaktualizowana.
Aktualizacja nie jest pojedynczą transakcją atomową: zmiany tożsamości i dołączenie dokumentów potwierdzających mogą nastąpić przed późniejszym błędem. Nie jest udostępniany klucz idempotencji. Po otrzymaniu niejednoznacznej odpowiedzi sprawdź profil i załączniki przed ponowieniem żądania; ponowne przesłanie dokumentów potwierdzających może utworzyć duplikaty. Aktualizacja profilu nie oznacza zatwierdzenia dokumentów potwierdzających ani nie aktywuje numeru.