Consulter les exigences d’enregistrement

Sélectionner le pays et le type de numéro

Choisissez un pays d’enregistrement, puis utilisez un nom renvoyé par get_document_number_types. Envoyez ce nom dans le paramètre number_type, et non un identifiant de type ou une catégorie générale de recherche de numéros.

Lire les instructions renvoyées

Conservez les identifiants des exigences et des relations pour le processus de gestion des identités et des documents concerné. Cet appel renvoie des exigences ; il ne valide ni ne soumet vos fichiers. Suivez les instructions renvoyées ainsi que toute exigence propre au numéro sélectionné.

Ne pas interpréter une erreur comme une exemption

L’erreur concernant un pays non valide ou l’absence de documents d’enregistrement requis pour ce pays regroupe deux situations. Elle ne prouve pas que l’enregistrement est inutile. Un échec de recherche ou un résultat vide ne constitue pas non plus une approbation du client ou du numéro. Contactez l’assistance si le résultat n’est pas clair.

Requête

Utilisez les identifiants de votre compte API activé via HTTPS. L’authentification de base et les jetons au porteur activés pour le compte API sont pris en charge ; les restrictions du compte s’appliquent.

POST avec application/json ou application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

Réponse

Vérifiez status.code dans le corps JSON ainsi que le statut HTTP. response est une ressource unique d’exigences comprenant id, type et attributes, ainsi que relationships lorsque ces relations sont renvoyées. Les identifiants présents dans la ressource et dans les données des relations sont opaques. Les balises HTML sont supprimées du texte facultatif restriction_message ; traitez le texte restant comme du texte, et non comme du HTML fiable. Le gestionnaire renvoie la première ressource d’exigences ; n’en déduisez donc pas que cette réponse constitue une liste exhaustive. La présence des attributs et des relations dépend du pays et du type ; l’exemple ne constitue pas un schéma fixe et complet.

Structure de réponse fournie à titre d’illustration ; il ne s’agit ni de données de compte en temps réel ni d’un devis actuel.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Erreurs

• 400: Échec de la validation du pays et de number_type : fournissez les deux valeurs obligatoires. Le texte de validation peut contenir une mise en forme.
• 400: Invalid country ISO or No country registration documents required. : ce message ambigu ne prouve pas à lui seul l’existence d’une exemption d’enregistrement.
• 400: Invalid number type : utilisez un nom de type renvoyé. L’ancien message d’erreur énumère Global, Local, Mobile, National, Shared Cost et Toll Free.
• 500: Unable to load registration requirements for the specified country and number type. : les exigences n’ont pas été renvoyées correctement. Réessayez plus tard ou contactez l’assistance.

Disponibilité et effets de bord

• Cette consultation du catalogue et des exigences ne crée pas d’identité, ne téléverse pas de justificatif, n’enregistre pas de numéro et ne passe pas de commande.
• Une réponse réussie du catalogue ne constitue ni une approbation de vos documents ni une confirmation que le numéro sélectionné peut être activé.