Choisissez une catégorie de justificatifs
Utilisez la catégorie et le type d’entité renvoyés pour préparer les justificatifs requis pour une identité. Cette liste décrit des catégories ; elle ne répertorie pas les fichiers que vous avez téléversés et ne vaut approbation d’aucun justificatif.
Respectez les exigences applicables
La présence d’une catégorie dans la liste ne signifie pas qu’elle répond aux exigences de tous les pays, de tous les types de numéros ou de toutes les identités de clients. Consultez les exigences applicables avant de téléverser des justificatifs et traitez les identifiants renvoyés comme des valeurs opaques.
Requête
Utilisez les identifiants de votre compte API activé via HTTPS. L’authentification de base et les jetons porteurs activés du compte API sont pris en charge ; les restrictions du compte s’appliquent.
GET avec tout paramètre documenté dans le chemin de l’URL.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_proof_types"Réponse
Vérifiez status.code dans le corps JSON ainsi que le statut HTTP. response est un tableau d’objets comportant les champs id, name et entity_type. Ces valeurs proviennent du catalogue actuel des justificatifs. Les identifiants sont opaques ; copiez-les au lieu d’en construire un ou d’en générer un par hachage. Un catalogue vide peut être renvoyé avec succès. Ne définissez pas en dur une énumération exhaustive des types d’entités à partir de cet exemple.
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": "",
"results": 1
},
"response": [
{
"id": "PROOF_TYPE_ID_FROM_RESPONSE",
"name": "Example proof category",
"entity_type": "ENTITY_TYPE_FROM_RESPONSE"
}
]
}Erreurs
- Vérifiez status.code et status.msg pour détecter les erreurs d’authentification ou de service. Le renvoi réussi d’un catalogue vide ne vaut ni approbation d’un document ni dispense d’enregistrement.
Disponibilité et effets de bord
- Cette consultation du catalogue et des exigences ne crée aucune identité, ne téléverse aucun justificatif, n’enregistre aucun numéro et ne passe aucune commande.
- Une réponse réussie du catalogue ne vaut ni approbation de vos documents ni confirmation qu’un numéro sélectionné peut être activé.