Développeurs

POST/v3/update_document/{uuid}

Mettre à jour un profil d’enregistrement

Envoyez toutes les informations modifiables du profil et gérez l’ancien format de réponse de succès.

Sur cette page
  1. Remplacer les informations modifiables d’un profil
  2. Requête de mise à jour
  3. Options avancées : ajouter des justificatifs déjà téléversés
  4. Ancien format des réponses de succès et d’échec
  5. Limites actuelles de la mise à jour et reprise après incident

Remplacer les informations modifiables d’un profil

Mettez à jour un profil d’enregistrement existant appartenant au compte à l’aide de son UUID local obtenu via create_document ou documents. Cette opération modifie les données du compte et celles de l’opérateur en amont. Elle ne modifie pas le type d’identité Personal/Business enregistré et ne constitue pas une requête PATCH portant sur une partie des champs.

Requête de mise à jour

Authentifiez-vous avec votre compte API MultiTEL activé depuis une adresse IP autorisée. Les exemples utilisent des identifiants placés dans des variables d’environnement et des données fictives. Lisez les champs JSON status.code et status.msg, ainsi que la réponse 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": ""
}

L’exemple présente un profil Personal ; remplacez son contenu par toutes les informations souhaitées de l’utilisateur final et sa signature autorisée. N’envoyez pas de signatures factices ni de valeurs vides dans le but de conserver des données. Les entrées au format JSON ou encodées comme un formulaire sont prises en charge.

Exigences relatives aux champs de mise à jour
ChampsComportement
first_name, last_name, city, postal_code, addressObligatoires ; au maximum 64 caractères chacun.
phone_numberValeur numérique obligatoire d’au moins huit caractères ; utilisez des chiffres au format international, indicatif du pays compris.
signatureObligatoire. Le portail fournit les octets PNG encodés en Base64, sans le préfixe d’URL de données.
countryFournissez un code ISO du pays de l’adresse issu du catalogue d’enregistrement. Le gestionnaire détermine le pays correspondant, bien que la mise à jour de l’adresse examinée ne modifie pas l’association au pays.
nationalityCode ISO de pays obligatoire pour un profil Personal existant.
company_name, incorporation_countryObligatoires pour un profil Business existant ; le nom de l’entreprise doit comporter au maximum 64 caractères et le pays de constitution doit être indiqué par un code ISO.
emailAdresse e-mail valide facultative, de 254 caractères maximum. Omettez ce champ pour conserver l’adresse e-mail de contact enregistrée ; envoyez une valeur vide pour l’effacer localement.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idEnvoyez les valeurs actuelles souhaitées. Les valeurs omises sont vides par défaut et peuvent écraser les valeurs déjà enregistrées.

Les règles d’enregistrement propres à chaque pays peuvent exiger des informations ou des formats supplémentaires. Ne reconstituez pas une mise à jour complète à partir de get_document uniquement : sa réponse limitée ne contient ni les sélecteurs de pays, ni email, ni les identifiants d’entité. Conservez les données sources que vous êtes autorisé à utiliser ou utilisez l’éditeur de documents du portail.

Options avancées : ajouter des justificatifs déjà téléversés

Les tableaux facultatifs identity_encryptfiles et address_encryptfiles acceptent des références actives appartenant au compte et provenant de create_encrypt_files. Respectez la catégorie d’entité du fichier téléversé et envoyez la requête avant l’expiration de la référence. Chaque fichier est joint dans une requête de justificatif distincte, même si plusieurs fichiers ont le même type de justificatif. Pour un justificatif d’identité composé de plusieurs fichiers, utilisez ensuite le processus de jonction de justificatifs avec un seul tableau.

Si une preuve d'adresse ultérieure est rejetée pour une adresse nouvellement créée, ne substituez pas l'UUID du profil et ne recréez pas l'identité à répétition. Arrêtez-vous et vérifiez le profil dans le portail ou auprès de l'assistance. Le chemin de relecture et de consultation des preuves d'adresse reste une limitation de l'examen.

Ancien format des réponses de succès et d’échec

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

Le code de succès habituel de ce point de terminaison est la chaîne success, au lieu du nombre 200. Un échec habituel en amont ou local peut utiliser la chaîne error. Le code numérique 400 correspond à des champs invalides ou à des échecs liés aux justificatifs, 404 à un profil absent ou à une référence de fichier téléversé invalide, et 500 à un corps de requête vide ou à un pays impossible à déterminer. Lisez le message et toutes les entrées de validation ; ne considérez pas le seul statut HTTP 200 comme un succès.

Limites actuelles de la mise à jour et reprise après incident

Un succès signalé ne garantit pas que tous les champs en amont ont été modifiés. Le code examiné peut enregistrer le profil local après l’échec d’une mise à jour d’adresse en amont. La mise à jour de l’identité en amont n’inclut pas email. Ce traitement ne permet pas d’établir que le pays de l’adresse est modifié ni que la description de l’adresse est synchronisée. Si vous avez besoin de ces modifications, vérifiez le résultat dans le portail et contactez l’assistance au lieu de supposer que l’enregistrement en amont a été mis à jour.

La mise à jour ne constitue pas une transaction atomique unique : des modifications d’identité et des ajouts de justificatifs peuvent avoir lieu avant un échec ultérieur. Aucune clé d’idempotence n’est exposée. Après une réponse incertaine, inspectez le profil et les pièces jointes avant de réessayer ; des envois répétés de justificatifs peuvent créer des doublons. La mise à jour d’un profil ne vaut pas approbation des justificatifs et n’active pas de numéro.