Programiści

POST/v3/create_document

Tworzenie profilu rejestracyjnego

Utwórz profil tożsamości/adresu i zachowaj jego odrębne identyfikatory profilu i podmiotu.

Na tej stronie
  1. Utwórz profil tylko raz
  2. Żądanie utworzenia
  3. Zachowaj wszystkie trzy identyfikatory
  4. Zaawansowane: dołączanie wcześniej przesłanych dowodów podczas tworzenia
  5. Błędy i częściowe utworzenie

Utwórz profil tylko raz

To żądanie tworzy lokalny profil rejestracyjny wraz z rekordami tożsamości i adresu u operatora. Zacznij od aktualnych krajów rejestracji, typów numerów oraz wymagań. Wymagania zależą od kraju i typu numeru, który zamierzasz zarejestrować.

Pomyślna odpowiedź na żądanie utworzenia nie oznacza zatwierdzenia regulacyjnego ani aktywacji numeru. Zapisz osobno UUID dokumentu, ID tożsamości i ID adresu: służą one różnym celom. To żądanie zmienia dane konta i nie jest operacją wyłącznie walidacyjną.

Żądanie utworzenia

Uwierzytelnij się za pomocą włączonego konta API MultiTEL i jego dozwolonego adresu IP. Przykłady używają poświadczeń HTTP Basic przechowywanych w zmiennych środowiskowych. Sprawdź zarówno odpowiedź HTTP, jak i wartość JSON status.code; sama odpowiedź HTTP 200 nie potwierdza powodzenia. Wszystkie wartości w przykładach są fikcyjne.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile.json \
  https://api.multitel.net/v3/create_document
{
  "identity_type": "Personal",
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "country": "US",
  "address": "1 Example Street",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}

Ten JSON to przykładowy profil typu Personal, a nie gotowa do przesłania prawdziwa tożsamość. Zastąp jego dane i podpis informacjami o użytkowniku końcowym wymaganymi przez wybrane zasady rejestracji. Obsługiwane są również dane wejściowe w formacie formularza.

Pola profilu rejestracyjnego
PoleWymagalność i format
identity_typeWymagane. Użyj dokładnie wartości Personal lub Business; walidacja warunkowa zależy od wielkości liter.
first_name, last_nameWymagane, każde maksymalnie 64 znaki. W przypadku firmy podaj dane przedstawiciela wymagane przez wybrany kraj.
phone_numberWymagana numeryczna wartość telefonu, co najmniej osiem znaków. Do tej walidacji nadaje się numer międzynarodowy składający się wyłącznie z cyfr, wraz z kodem kraju; jest to numer kontaktowy, a nie zakup numeru.
city, postal_code, addressWymagane, każde maksymalnie 64 znaki.
countryWymagany kod ISO kraju adresu z katalogu rejestracji. Usługa rozwiązuje go do rekordu kraju operatora.
signatureWymagane dane podpisu. Obecny portal dostarcza bajty obrazu PNG w kodowaniu Base64 bez prefiksu data:image/png;base64,. Pozyskaj podpis użytkownika końcowego w ramach autoryzowanego procesu; niepusty symbol zastępczy nie jest prawidłowym podpisem.
nationalityWymagane dla Personal, jako kod ISO kraju. Nie zastępuj go UUID kraju.
company_name, incorporation_countryWymagane dla Business. Nazwa firmy może mieć maksymalnie 64 znaki; incorporation_country to kod ISO kraju.
emailOpcjonalny kontaktowy adres e-mail użytkownika końcowego, maksymalnie 254 znaki. Pominięty lub pusty adres e-mail nie dziedziczy adresu e-mail konta podstawowego.
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, descriptionOpcjonalne w tym handlerze, ale wybrany kraj lub operator może wymagać niektórych z nich. Podaj formaty wymagane dla danej rejestracji. Bezpośrednie wywołania API nie stosują automatycznie każdej normalizacji wykonywanej przez portal.

Ten bezpośredni handler v3 wymaga pól adresu i tworzy adres. Nie zakładaj, że dostępna jest przez niego portalowa opcja odroczenia adresu.

Zachowaj wszystkie trzy identyfikatory

Poniżej pokazano wybrane pola odpowiedzi; rzeczywista odpowiedź zawiera również przesłane informacje o profilu oraz dane podpisu. Traktuj pełną odpowiedź jako poufną.

{
  "status": {
    "code": 200,
    "msg": "Success Create Registration Detail."
  },
  "response": {
    "uuid": "11111111111111111111111111111111",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "country_iso": "US",
    "email": "end-user@example.com"
  }
}
  • response.uuid identyfikuje lokalny profil. Używaj go z get_document. W odpowiedziach documents i get_document ten sam identyfikator profilu nosi nazwę id.
  • response.identity_id identyfikuje tożsamość na potrzeby późniejszych dowodów tożsamości i dokumentów uzupełniających.
  • response.address_id identyfikuje utworzony adres. Przechowuj go osobno; UUID lokalnego profilu nie jest ID adresu. Zgodność późniejszego dołączania dowodów adresu dla nowo utworzonych profili jest nadal w trakcie przeglądu.

Dwa punkty końcowe odczytu profilu nie zwracają identity_id ani address_id, dlatego zachowaj oryginalną pomyślną odpowiedź na żądanie utworzenia. Jeśli została utracona, skorzystaj z widoku dokumentu w portalu lub skontaktuj się z pomocą techniczną, zanim utworzysz zastępczy profil.

Zaawansowane: dołączanie wcześniej przesłanych dowodów podczas tworzenia

Możesz podać identity_encryptfiles oraz address_encryptfiles jako tablice identyfikatorów zwróconych przez create_encrypt_files. Prześlij pliki z typem dowodu odpowiadającym kategorii podmiotu, a następnie wyślij żądanie przed upływem około 20-minutowego okresu ważności odwołania do pliku. Handler tworzenia sprawdza konto, kategorię i ważność każdego podanego odwołania.

Te pola mają inne nazwy niż pole encrypted_file_ids w późniejszym punkcie końcowym dołączania. Podczas tworzenia każdy plik jest wysyłany jako osobne żądanie dowodu, nawet jeśli kilka plików ma ten sam typ dowodu. W przypadku dowodu tożsamości, który musi zawierać kilka plików razem, użyj późniejszego żądania create_proof z jedną tablicą. Samo pomyślne utworzenie profilu nie dostarcza indywidualnych wyników zatwierdzenia dowodów.

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.

Błędy i częściowe utworzenie

Kod API 400 obejmuje walidację pól, błędy tworzenia u operatora oraz błędy lokalnego zapisu. Błędy walidacji mogą pojawić się jako wpisy z kluczami pól w response. Kod 500 jest używany dla niedostępnego/nieprawidłowego kraju rejestracji, a kod 404 dla brakujących lub wygasłych wcześniej przesłanych odwołań. Odczytuj status.msg oprócz samego kodu.

Lokalny profil i operacje u operatora nadrzędnego nie stanowią jednej atomowej transakcji. Nieudane żądanie może pozostawić stan po stronie operatora nawet wtedy, gdy żaden lokalny profil nie jest wyświetlany. Nie jest udostępniany żaden klucz idempotentności klienta. Po przekroczeniu limitu czasu lub niepewnym błędzie sprawdź istniejące profile i skontaktuj się z pomocą techniczną, zanim powtórzysz tworzenie; pusta lista documents nie jest dowodem, że po stronie operatora nic nie utworzono.