Προγραμματιστές

POST/v3/create_document

Δημιουργία προφίλ εγγραφής

Δημιουργήστε ένα προφίλ ταυτότητας/διεύθυνσης και διατηρήστε ξεχωριστά τα αναγνωριστικά του προφίλ και των οντοτήτων.

Σε αυτή τη σελίδα
  1. Δημιουργήστε το προφίλ μία φορά
  2. Αίτημα δημιουργίας
  3. Διατηρήστε και τα τρία αναγνωριστικά
  4. Για προχωρημένους: επισύναψη ήδη ανεβασμένων αποδεικτικών κατά τη δημιουργία
  5. Αποτυχίες και μερική δημιουργία

Δημιουργήστε το προφίλ μία φορά

Αυτό το αίτημα δημιουργεί ένα τοπικό προφίλ εγγραφής μαζί με εγγραφές ταυτότητας και διεύθυνσης στον πάροχο. Ξεκινήστε από τα τρέχοντα στοιχεία για χώρες εγγραφής, τύπους αριθμών και απαιτήσεις. Οι απαιτήσεις εξαρτώνται από τη χώρα και τον τύπο αριθμού που σκοπεύετε να καταχωρίσετε.

Μια επιτυχής απόκριση δημιουργίας δεν αποτελεί κανονιστική έγκριση ούτε ενεργοποίηση αριθμού. Αποθηκεύστε ξεχωριστά το UUID του εγγράφου, το αναγνωριστικό ταυτότητας και το αναγνωριστικό διεύθυνσης: εξυπηρετούν διαφορετικούς σκοπούς. Αυτό το αίτημα τροποποιεί δεδομένα του λογαριασμού και δεν είναι λειτουργία μόνο επικύρωσης.

Αίτημα δημιουργίας

Πραγματοποιήστε έλεγχο ταυτότητας με τον ενεργοποιημένο λογαριασμό MultiTEL API σας και την επιτρεπόμενη διεύθυνση IP του. Τα παραδείγματα χρησιμοποιούν διαπιστευτήρια HTTP Basic αποθηκευμένα σε μεταβλητές περιβάλλοντος. Ελέγξτε τόσο την απόκριση HTTP όσο και το πεδίο JSON status.code· μια απόκριση HTTP 200 από μόνη της δεν τεκμηριώνει επιτυχία. Όλες οι τιμές των παραδειγμάτων είναι πλασματικές.

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

Το JSON είναι ένα ενδεικτικό προφίλ Personal, όχι μια πραγματική ταυτότητα έτοιμη για υποβολή. Αντικαταστήστε τα στοιχεία και την υπογραφή του με τις πληροφορίες τελικού χρήστη που απαιτούνται από τους επιλεγμένους κανόνες εγγραφής. Υποστηρίζεται επίσης είσοδος κωδικοποιημένη ως φόρμα.

Πεδία προφίλ εγγραφής
ΠεδίοΥποχρεωτικό και μορφή
identity_typeΥποχρεωτικό. Χρησιμοποιήστε την ακριβή τιμή Personal ή Business· η επικύρωση υπό όρους εξαρτάται από τη χρήση κεφαλαίων.
first_name, last_nameΥποχρεωτικά, το καθένα έως 64 χαρακτήρες. Για επιχείρηση, παρέχετε τα στοιχεία του εκπροσώπου που απαιτούνται από την επιλεγμένη χώρα.
phone_numberΥποχρεωτική αριθμητική τιμή τηλεφώνου, τουλάχιστον οκτώ χαρακτήρες. Ένας διεθνής αριθμός μόνο με ψηφία που περιλαμβάνει τον κωδικό χώρας είναι κατάλληλος για αυτή την επικύρωση· πρόκειται για αριθμό επικοινωνίας, όχι για αγορά αριθμού.
city, postal_code, addressΥποχρεωτικά, το καθένα έως 64 χαρακτήρες.
countryΥποχρεωτικός κωδικός ISO της χώρας διεύθυνσης από τον κατάλογο εγγραφής. Η υπηρεσία τον αντιστοιχίζει στην εγγραφή χώρας του παρόχου.
signatureΥποχρεωτικά δεδομένα υπογραφής. Η τρέχουσα πύλη παρέχει τα byte της εικόνας PNG σε Base64 χωρίς το πρόθεμα data:image/png;base64,. Αποκτήστε την υπογραφή του τελικού χρήστη μέσω της εξουσιοδοτημένης ροής εργασίας σας· ένα μη κενό σύμβολο κράτησης θέσης δεν αποτελεί ουσιαστική υπογραφή.
nationalityΥποχρεωτικό για Personal, ως κωδικός ISO χώρας. Μην το αντικαθιστάτε με UUID χώρας.
company_name, incorporation_countryΥποχρεωτικά για Business. Η επωνυμία της εταιρείας είναι έως 64 χαρακτήρες· το incorporation_country είναι κωδικός ISO χώρας.
emailΠροαιρετικό email επικοινωνίας του τελικού χρήστη, έως 254 χαρακτήρες. Παραλειφθέν ή κενό email δεν κληρονομεί το email του βασικού λογαριασμού.
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, descriptionΠροαιρετικά σε αυτόν τον χειριστή, αλλά η επιλεγμένη χώρα/πάροχος μπορεί να απαιτεί ορισμένα από αυτά. Παρέχετε τις μορφές που απαιτούνται για τη συγκεκριμένη εγγραφή. Οι απευθείας κλήσεις API δεν εφαρμόζουν αυτόματα κάθε κανονικοποίηση που εκτελεί η πύλη.

Αυτός ο απευθείας χειριστής v3 απαιτεί τα πεδία διεύθυνσης και δημιουργεί διεύθυνση. Μην υποθέτετε ότι η επιλογή αναβολής διεύθυνσης της πύλης είναι διαθέσιμη μέσω αυτού.

Διατηρήστε και τα τρία αναγνωριστικά

Παρακάτω εμφανίζονται επιλεγμένα πεδία της απόκρισης· η πραγματική απόκριση περιέχει επίσης τις υποβληθείσες πληροφορίες προφίλ και τα δεδομένα υπογραφής. Χειριστείτε ολόκληρη την απόκριση ως ιδιωτική.

{
  "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 προσδιορίζει το τοπικό προφίλ. Χρησιμοποιήστε το με το get_document. Στις αποκρίσεις των documents και get_document, το ίδιο αναγνωριστικό προφίλ ονομάζεται id.
  • response.identity_id προσδιορίζει την ταυτότητα για μεταγενέστερα αποδεικτικά ταυτότητας και δικαιολογητικά έγγραφα.
  • response.address_id προσδιορίζει τη διεύθυνση που δημιουργήθηκε. Διατηρήστε το ξεχωριστά· το UUID του τοπικού προφίλ δεν είναι αναγνωριστικό διεύθυνσης. Η συμβατότητα μεταγενέστερης επισύναψης αποδεικτικού διεύθυνσης για νεοδημιουργημένα προφίλ βρίσκεται ακόμη υπό εξέταση.

Τα δύο τελικά σημεία ανάγνωσης προφίλ δεν επιστρέφουν identity_id ή address_id, επομένως διατηρήστε την αρχική επιτυχή απόκριση δημιουργίας. Αν χάθηκε, χρησιμοποιήστε την προβολή εγγράφων της πύλης ή επικοινωνήστε με την υποστήριξη πριν δημιουργήσετε αντικατάσταση.

Για προχωρημένους: επισύναψη ήδη ανεβασμένων αποδεικτικών κατά τη δημιουργία

Μπορείτε να παρέχετε τα identity_encryptfiles και address_encryptfiles ως πίνακες αναγνωριστικών που επιστρέφονται από το create_encrypt_files. Ανεβάστε χρησιμοποιώντας έναν τύπο αποδεικτικού για την αντίστοιχη κατηγορία οντότητας και έπειτα υποβάλετε πριν από τη λήξη της αναφοράς αρχείου, που είναι περίπου 20 λεπτά. Ο χειριστής δημιουργίας ελέγχει τον λογαριασμό, την κατηγορία και τη λήξη κάθε παρεχόμενης αναφοράς.

Αυτά τα πεδία έχουν διαφορετικά ονόματα από το encrypted_file_ids του μεταγενέστερου τελικού σημείου επισύναψης. Κατά τη δημιουργία, κάθε αρχείο αποστέλλεται ως ξεχωριστό αίτημα αποδεικτικού, ακόμη και όταν πολλά αρχεία μοιράζονται έναν τύπο αποδεικτικού. Για αποδεικτικό ταυτότητας που πρέπει να περιέχει πολλά αρχεία μαζί, χρησιμοποιήστε το μεταγενέστερο αίτημα create_proof με έναν πίνακα. Η επιτυχής δημιουργία προφίλ από μόνη της δεν παρέχει αποτελέσματα έγκρισης για τα επιμέρους αποδεικτικά.

Αν ένα μεταγενέστερο αποδεικτικό διεύθυνσης απορριφθεί για μια νεοδημιουργημένη διεύθυνση, μην αντικαθιστάτε το UUID του προφίλ και μην δημιουργείτε ξανά την ταυτότητα επανειλημμένα. Σταματήστε και ελέγξτε το προφίλ στην πύλη ή με την υποστήριξη. Η διαδρομή ανάγνωσης/αναζήτησης αποδεικτικού διεύθυνσης παραμένει περιορισμός της εξέτασης.

Αποτυχίες και μερική δημιουργία

Ο κωδικός API 400 καλύπτει την επικύρωση πεδίων, τις αποτυχίες δημιουργίας στον πάροχο και τις αποτυχίες τοπικής αποθήκευσης. Τα σφάλματα επικύρωσης μπορεί να εμφανίζονται ως καταχωρίσεις με κλειδί ανά πεδίο στο response. Ο κωδικός 500 χρησιμοποιείται για μη διαθέσιμη/μη έγκυρη χώρα εγγραφής και ο κωδικός 404 για αναφορές ήδη ανεβασμένων αρχείων που λείπουν ή έχουν λήξει. Διαβάστε το status.msg μαζί με τον κωδικό.

Το τοπικό προφίλ και οι λειτουργίες του ανάντη παρόχου δεν αποτελούν μία ατομική συναλλαγή. Ένα αποτυχημένο αίτημα μπορεί να αφήσει κατάσταση ανάντη ακόμη και όταν δεν εμφανίζεται κανένα τοπικό προφίλ. Δεν εκτίθεται κλειδί idempotency πελάτη. Μετά από χρονικό όριο ή αβέβαιη αποτυχία, επιθεωρήστε τα υπάρχοντα προφίλ και επικοινωνήστε με την υποστήριξη πριν επαναλάβετε τη δημιουργία· μια κενή λίστα documents δεν αποδεικνύει ότι δεν δημιουργήθηκε τίποτα ανάντη.