Partager via


Analyseur d’ID (préversion)

ID Analyzer fournit plusieurs produits de vérification d’identité différents, vous devez acquérir des connaissances de base de chaque produit afin de choisir la meilleure solution pour votre application.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge de l’analyseur d’ID
URL https://www.idanalyzer.com/contact.html
Messagerie électronique support@idanalyzer.com
Métadonnées du connecteur
Éditeur Evith Techology
Site internet https://www.idanalyzer.com/
Politique de confidentialité https://www.idanalyzer.com/privacy-policy.html
Catégories Opérations informatiques ; Productivité

La plateforme ID Analyzer fournit aux entreprises, aux organisations et aux individus une solution de vérification d’identité véritablement globale qui fonctionne sans frontières, une solution qui peut être adaptée à vos besoins et demandes spécifiques et un système de sécurité qui est constamment mis à niveau et amélioré.

Fournir un accès complet à la vérification des identités et des informations sur plus de 4 000 formes d’ID différentes dans 190 pays du monde entier, c’est une solution globale conçue avec le monde moderne à l’esprit.

Prerequisites

  • Un compte de développeur avec ID Analyzer. Vous pouvez vous inscrire à un compte gratuit lors de l’inscription
  • Après vous être inscrit au compte, vous recevrez une clé API dans le portail web d’ID Analyzer. Utilisez cette clé API pour vous authentifier auprès du connecteur

Comment obtenir des informations d’identification

  1. Accédez à l’inscription
  2. Entrez les informations requises.
  3. Vérifiez votre e-mail lorsque vous y êtes invité.
  4. Vous verrez votre nouvelle clé API dans le portail web d’ID Analyzer avec les détails de votre compte. Appuyez sur le bouton « Copier » pour l’enregistrer dans votre Presse-papiers pour une utilisation ultérieure.

Questions fréquentes (FAQ)

Je m’inquiète de la confidentialité de mon client, l’API enregistre-t-elle des informations sur mon client ?

Tout sera stocké uniquement dans le coffre du client et ne sera pas divulguée arbitrairement. Il n’aura aucune copie dans un autre endroit.

Quelles sont les « crédits » pour montrant comment puis-je acheter des crédits d’API ?

Crédit prépayé restant pour votre compte. Si vous disposez d’un plan mensuel, votre quota mensuel sera utilisé avant le crédit prépayé.

Comment vérifier si un document est réel ou faux ?

Activez l’authentification, le résultat contiendra le score d’authentification.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Clé API API securestring Clé API pour cette API Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Ajouter une image au coffre

Vous pouvez charger une image et l’ajouter à une entrée de coffre existante en effectuant une requête HTTP POST.

Création d’une session de signature DocuPass

Vous pouvez créer une session de signature où l’utilisateur passe en revue et e-sign legal document sans vérification d’identité. Si vous souhaitez effectuer la vérification d’identité et que votre utilisateur signe un document, créez plutôt une session de vérification d’identité.

Création d’une session DocuPass

Vous pouvez créer une session de vérification pour chaque utilisateur nécessitant une vérification d’identité.

Entrées de liste et de filtre

Pour répertorier toutes les entrées stockées dans le coffre ou rechercher des entrées avec des valeurs spécifiques, envoyez une requête HTTP POST au point de terminaison suivant.

Formation à la recherche de visages

Avant d’effectuer la recherche de visages, vous devez émettre une commande d’apprentissage pour entraîner les jeux de données de document à l’intérieur de votre coffre. Vous pouvez également entraîner vos données de coffre via le portail web. La tâche d’apprentissage est asynchrone, le temps d’apprentissage dépend du nombre d’entrées et d’images du coffre. Cela peut prendre de plusieurs secondes à une heure.

Mettre à jour l’entrée du coffre

Vous pouvez mettre à jour la valeur d’un champ unique ou de valeurs de plusieurs champs dans une entrée de coffre en effectuant une requête HTTP POST.

Obtenir le contenu d’entrée du coffre

Lorsque des entrées sont ajoutées au coffre, l’API Core et l’API DocuPass retournent un identificateur d’entrée de coffre nommé vaultid. Vous pouvez utiliser l’identificateur pour interroger le contenu d’une entrée dans le coffre en envoyant une requête HTTP POST au point de terminaison suivant.

Paramètre d’API de base

API de vérification d’ID de fonction multiple pour vérifier le document physique distant, son authenticité et son visage correspondent au document avec votre photo utilisateur.

Recherche de base de données AML

L’API AML vous permet de rechercher dans la base de données AML globale ID Analyzer des sanctions, des PPE et des criminels recherchés à l’aide d’un nom, d’un numéro de document ou des deux. Vous pouvez filtrer davantage les résultats avec anniversaire et nationalité.

Recherche de visages

La recherche de visages vous permet de rechercher l’intégralité du coffre à l’aide d’une image d’une personne. Pour utiliser la fonctionnalité de recherche de visages, vous devez activer l’indexation de recherche de visages sous le portail web et entraîner régulièrement vos jeux de données de coffre.

Supprimer l’entrée du coffre

Vous pouvez supprimer des entrées de coffre uniques ou multiples en effectuant une requête HTTP POST.

Supprimer une image du coffre

Vous pouvez supprimer une image à l’intérieur d’une entrée de coffre en effectuant une requête HTTP POST. Notez qu’après la suppression d’une image, l’URL de l’image peut toujours être accessible pendant une courte période en raison de la mise en cache.

Validation du rappel

Pour vous assurer que les données ont été envoyées à partir de notre serveur.

État de l’entraînement

Vérifiez si la formation du coffre est toujours en cours ou s’est terminée.

Ajouter une image au coffre

Vous pouvez charger une image et l’ajouter à une entrée de coffre existante en effectuant une requête HTTP POST.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

pièce d'identité
id True string

Identificateur d’entrée du coffre à ajouter une image à

type
type True string

Définir le type d’image : 0=document et 1=person

image
image string

Données d’image encodées en base64.

imageurl
imageurl string

URL de l’image distante.

Retours

Nom Chemin d’accès Type Description
success
success integer
pièce d'identité
image.id string

Identificateur d’image

type
image.type string

0 pour le document et 1 pour la personne

hash
image.hash string

Hachage MD5 de l’image

URL
image.url string

URL de l’image

createtime
image.createtime string

Image d’heure téléchargée au format UTC

Création d’une session de signature DocuPass

Vous pouvez créer une session de signature où l’utilisateur passe en revue et e-sign legal document sans vérification d’identité. Si vous souhaitez effectuer la vérification d’identité et que votre utilisateur signe un document, créez plutôt une session de vérification d’identité.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

companyname
companyname True string

Le nom de votre entreprise s’affiche tout au long de la page de vérification afin que l’utilisateur final sache qu’il envoie des informations d’identité à votre entreprise

template_id
template_id string

ID de modèle de contrat pour remplir automatiquement les données utilisateur.

contract_format
contract_format string

Format du document de sortie. (PDF, DOCX, HTML)

callbackurl
callbackurl string

Le fichier de contrat est envoyé à cette URL. Vous devez activer vault_save ou spécifier un rappel pour pouvoir enregistrer le document généré.

successredir
successredir string

Le navigateur est redirigé vers cette URL une fois que le document a été révisé et signé. Le code de référence DocuPass et le customid sont ajoutés à la fin de l’URL

customid
customid string

Chaîne personnalisée qui sera renvoyée à l’URL de rappel de votre serveur et ajoutée aux URL de redirection définies par successredir et failredir en tant que chaîne de requête. Il est utile d’identifier votre utilisateur dans votre base de données. Cette valeur est stockée sous docupass_customid sous Coffre.

réutilisable
reusable boolean

l’embrayage de ce paramètre permet à plusieurs utilisateurs d’examiner et de signer des documents via la même URL, un nouveau code de référence DocuPass sera généré automatiquement pour chaque utilisateur.

sms_contract_link
sms_contract_link string

Numéro de téléphone mobile international complet

vault_save
vault_save boolean

Enregistrez le document généré dans le coffre. Vous devez activer vault_save ou spécifier un rappel pour pouvoir enregistrer le document généré.

nobranding
nobranding boolean

Masquer le logo de personnalisation sur toutes les pages DocuPass.

customhtmlurl
customhtmlurl string

Utilisez votre propre page HTML et CSS pour DocuPass. Une fois que vous avez apporté des modifications au code HTML et CSS, vous devez les charger sur votre propre serveur, au début de chaque session DocuPass télécharge la dernière page HTML à partir de votre serveur.

language
language string

DocuPass détecte automatiquement la langue de l’appareil utilisateur et affiche la langue correspondante. Définissez ce paramètre pour remplacer la détection automatique de la langue. (en, fr, nl, de, es, zh-TW, zh-CN)

expiration
expiry integer

Nombre de secondes avant l’expiration de la session DocuPass. À l’expiration, l’utilisateur ne pourra pas continuer avec la session active, un rappel ayant échoué sera également envoyé.

qr_color
qr_color string

Couleur du premier plan du code QR

qr_bgcolor
qr_bgcolor string

Couleur de l’arrière-plan du code QR

qr_size
qr_size integer

Taille du code QR

qr_margin
qr_margin integer

Épaisseur de bordure du code QR

Retours

Nom Chemin d’accès Type Description
référence
reference string

Code de référence unique pour la session DocuPass.

customid
customid string

ID personnalisé utilisé lors de la création d’une session DocuPass.

URL
url string

URL unique de l’application web DocuPass. Envoyez ce lien à votre utilisateur, ou incorporez-le dans votre site web ou votre application mobile pour passer en revue et signer le document.

qrcode
qrcode string

URL de l’image de code QR pour que votre utilisateur analyse

base_url
base_url string

Vous pouvez envoyer ce lien à votre utilisateur et lui demander d’entrer du code de référence pour signer des documents.

html_qrcode
html_qrcode string

Exemple de code HTML pour afficher le code QR sur votre page web.

html_iframe
html_iframe string

Exemple de code HTML pour insérer un iframe dans votre page web.

smssent
smssent string

Contient le numéro de téléphone comme confirmation lorsque sms a été envoyé avec succès via sms_contract_link paramètre.

expiration
expiry integer

Horodatage UNIX UTC indiquant quand cette session expirera, à l’expiration, l’utilisateur ne pourra plus utiliser le lien et un rappel ayant échoué sera envoyé.

Création d’une session DocuPass

Vous pouvez créer une session de vérification pour chaque utilisateur nécessitant une vérification d’identité.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

type
type integer

0 : Module Iframe ,1 : Module mobile, 2 : Module de redirection, 3 : Module Live Mobile

companyname
companyname True string

Nom de votre entreprise ou de votre produit.

callbackurl
callbackurl string

URL de webhook/rappel pour recevoir le résultat de la vérification.

biométrique
biometric integer

Demandez à l’utilisateur de prendre une photo ou une vidéo de selfie pour la vérification du visage.

biometric_threshold
biometric_threshold float

Spécifier le score minimal pour passer la vérification biométrique faciale

authenticate_minscore
authenticate_minscore float

Le document doit respecter le score d’authenticité minimal pour réussir la validation. Définissez 0 pour désactiver la vérification de validité/authenticité.

authenticate_module
authenticate_module integer

Spécifiez le module utilisé pour valider le document.

maxattempt
maxattempt integer

Nombre maximal de tentatives d’échec pour chaque demande de vérification.

successredir
successredir string

Le navigateur est redirigé vers cette URL lorsque la vérification de l’identité réussit.

failredir
failredir string

Le navigateur est redirigé vers cette URL lorsque la vérification de l’identité a échoué.

customid
customid string

Il est utile d’identifier votre utilisateur dans votre base de données. Cette valeur est stockée sous docupass_customid sous Coffre.

réutilisable
reusable boolean

L’activation de ce paramètre permet à plusieurs utilisateurs de vérifier leur identité via la même URL, un nouveau code de référence DocuPass sera généré automatiquement pour chaque utilisateur.

phoneverification
phoneverification boolean

Indique si l’utilisateur doit entrer un numéro de téléphone pour vérification, DocuPass prend en charge la vérification des numéros mobiles ou fixes. (Abonné uniquement)

documenttype
documenttype string

L’utilisateur doit charger un type spécifique de document. Par exemple, « » accepterait à la fois le passeport et le permis de conduire.

documentcountry
documentcountry string

Code pays ISO ALPHA-2.

documentregion
documentregion string

Nom complet de l’état/région ou abréviation.

doublesidecheck
dualsidecheck boolean

Vérifiez si les noms, le numéro de document et le type de document correspondent entre l’avant et l’arrière du document lors de l’analyse double côté. Si des informations ne correspondent pas à l’erreur 14 sont levées.

verify_expiry
verify_expiry boolean

Accepter uniquement le document qui n’a pas expiré

verify_documentno
verify_documentno string

Numéro de document nécessitant une vérification.

verify_name
verify_name string

Nom complet incluant le prénom et le nom nécessitant une vérification.

verify_dob
verify_dob string

Date de naissance nécessitant une vérification, au format AAAA/MM/DD.

verify_age
verify_age string

Plage d’âge, exemple : 18-40

verify_address
verify_address string

Adresse complète nécessitant la vérification.

verify_postcode
verify_postcode string

Code postal complet nécessitant une vérification.

verify_phone
verify_phone string

Numéro de téléphone complet nécessitant une vérification.

vault_save
vault_save boolean

Enregistrez les documents utilisateur et les informations analysées dans le coffre.

return_documentimage
return_documentimage boolean

Renvoyer l’image de document chargée par l’utilisateur dans la demande de rappel.

return_faceimage
return_faceimage boolean

Renvoyer l’image visage chargée par l’utilisateur dans la demande de rappel.

return_type
return_type integer

Spécifiez le type d’image retourné, soit le contenu d’image codé en base64, soit une URL vers l’image. (L’URL de l’image sera conservée pendant seulement 7 jours)

welcomemessage
welcomemessage string

Remplacez le message d’accueil générique sur la première page par votre texte personnalisé (1 000 caractères maximum)

nobranding
nobranding boolean

Masquer le logo de personnalisation sur toutes les pages DocuPass. (Abonné uniquement)

logo
logo string

Logo de personnalisation personnalisé. (Abonné uniquement)

customhtmlurl
customhtmlurl string

Utilisez votre propre page HTML et CSS pour DocuPass. (Abonné uniquement)

language
language string

DocuPass détecte automatiquement la langue de l’appareil utilisateur et affiche la langue correspondante.

expiration
expiry integer

Nombre de secondes avant l’expiration de la session DocuPass. À l’expiration, l’utilisateur ne pourra pas continuer avec la session active, un rappel ayant échoué sera également envoyé.

qr_color
qr_color string

Couleur du premier plan du code QR. (Uniquement pour Live Mobile et Standard Mobile)

qr_bgcolor
qr_bgcolor string

Couleur de l’arrière-plan du code QR. (Uniquement pour Live Mobile et Standard Mobile)

qr_size
qr_size integer

Taille du code QR(1-50). (Uniquement pour Live Mobile et Standard Mobile)

qr_margin
qr_margin integer

Épaisseur de bordure du code QR(1-50). (Uniquement pour Live Mobile et Standard Mobile)

Retours

Nom Chemin d’accès Type Description
référence
reference string

Code de référence unique pour la session DocuPass.

type
type integer

Type de module DocuPass créé.

customid
customid string

ID personnalisé utilisé lors de la création d’une session DocuPass.

URL
url string

URL unique de l’application web DocuPass. Envoyez ce lien à votre utilisateur, ou incorporez-le dans votre site web ou votre application mobile pour commencer la vérification de l’identité.

qrcode
qrcode string

URL de l’image de code QR pour que votre utilisateur analyse

base_url
base_url string

Vous pouvez envoyer ce lien à votre utilisateur et lui demander d’entrer du code de référence pour démarrer la vérification.

html
html string

Exemple de code HTML que vous pouvez insérer dans votre page web.

smssent
smssent integer

Contient le numéro de téléphone comme confirmation lorsque sms a été envoyé avec succès via sms_verification_link paramètre.

expiration
expiry integer

Horodatage UNIX UTC indiquant quand cette session expirera, à l’expiration, l’utilisateur ne pourra plus utiliser le lien et un rappel ayant échoué sera envoyé.

Entrées de liste et de filtre

Pour répertorier toutes les entrées stockées dans le coffre ou rechercher des entrées avec des valeurs spécifiques, envoyez une requête HTTP POST au point de terminaison suivant.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

orderby
orderby string

Nom du champ utilisé pour classer le résultat.

sort
sort string

ASC pour trier les résultats dans l’ordre croissant, DESC pour trier dans l’ordre décroissant.

limit
limit integer

Nombre d’entrées de coffre à retourner. (1 à 100)

offset
offset integer

Renvoyer la liste à partir d’une entrée spécifique, par exemple, quand limit=10, pour accéder à la troisième page des résultats, utiliser offset=20

Filter
filter array of string

Filter

Retours

Nom Chemin d’accès Type Description
limit
limit integer

Limite actuelle

offset
offset integer

Décalage actuel

nextoffset
nextoffset integer

Valeur de décalage pour le jeu de données suivant. Si le jeu de données actuel est le dernier jeu de données, ce champ ne sera pas retourné.

total
total integer

Nombre total d’entrées trouvées.

items
items array of

Tableau d’entrées trouvées et de contenu complet, identique au contenu retourné par la méthode GET.

Formation à la recherche de visages

Avant d’effectuer la recherche de visages, vous devez émettre une commande d’apprentissage pour entraîner les jeux de données de document à l’intérieur de votre coffre. Vous pouvez également entraîner vos données de coffre via le portail web. La tâche d’apprentissage est asynchrone, le temps d’apprentissage dépend du nombre d’entrées et d’images du coffre. Cela peut prendre de plusieurs secondes à une heure.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

Retours

Nom Chemin d’accès Type Description
success
success integer

Mettre à jour l’entrée du coffre

Vous pouvez mettre à jour la valeur d’un champ unique ou de valeurs de plusieurs champs dans une entrée de coffre en effectuant une requête HTTP POST.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

pièce d'identité
id True string

Identificateur d’entrée du coffre.

Adresse1
address1 string

Ligne d’adresse 1.

Adresse2
address2 string

Ligne d’adresse 2.

bloquer
block string

Définissez ce paramètre pour empêcher l’envoi du même document à l’API Core ou à DocuPass. 0 : Aucun bloc 1 : Bloquer le numéro de document 2 : Bloquer le prénom/le nom 3 : Bloquer à la fois le numéro de document et le prénom/nom.

customdata1
customdata1 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter des mémo personnalisés à l’entrée.

customdata2
customdata2 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter des mémo personnalisés à l’entrée.

customdata3
customdata3 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter des mémo personnalisés à l’entrée.

customdata4
customdata4 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter des mémo personnalisés à l’entrée.

customdata5
customdata5 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter des mémo personnalisés à l’entrée.

Dob
dob string

Date de naissance (AAAA-MM-DD).

nom_document
documentName string

Nom du document.

documentNumber
documentNumber string

Identificateur unique du document (Passport No./Driver License No. etc. )

documentType
documentType string

P : Passport D : Driver’s License I : Identity Card V : Visa R : Residence Card O : Other

docupass_customid
docupass_customid string

customid passé lors de la création de la vérification DocuPass.

docupass_failedreason
docupass_failedreason string

Si la vérification DocuPass a échoué, la raison pour laquelle elle a échoué.

docupass_reference
docupass_reference string

Code de référence à la session DocuPass.

docupass_success
docupass_success string

0 ou 1, que la vérification DocuPass ait réussi ou échoué.

Messagerie électronique
email string

Adresse e-mail de l’utilisateur.

expiration
expiry string

Date d’expiration (AAAA -MM-DD)

eyeColor
eyeColor string

Couleur des yeux.

firstName
firstName string

Prénom / Nom donné

firstName_local
firstName_local string

Prénom dans la langue locale.

fullName
fullName string

Nom complet (La mise à jour d’autres champs de nom ne met pas à jour fullName)

fullName_local
fullName_local string

Prénom dans la langue locale.

hairColor
hairColor string

Couleur des cheveux.

height
height string

Hauteur de la personne.

issueAuthority
issueAuthority string

Émettre l’autorité du document.

Délivré
issued string

Date de problème (AAAA -MM-DD)

issuerOrg_iso2
issuerOrg_iso2 string

Documentez le code du pays émis dans ISO2. Exemple : États-Unis

issuerOrg_region_abbr
issuerOrg_region_abbr string

Abréviation de l’émetteur de document/état. Exemple : autorité de certification

issuerOrg_region_full
issuerOrg_region_full string

Sous-région/état de l’émetteur de document. Exemple : Californie

téléphone fixe
landline string

Numéro de téléphone fixe de l’utilisateur.

lastName
lastName string

Nom / Nom de famille.

lastName_local
lastName_local string

Nom dans la langue locale.

prénom
middleName string

Prénom(s).

middleName_local
middleName_local string

Prénom dans la langue locale.

mobile
mobile string

Numéro de téléphone mobile de l’utilisateur.

nationality_iso2
nationality_iso2 string

Nationalité de titulaire de documents dans ISO2. Exemple : États-Unis

optionalData
optionalData string

Données non spécifiées supplémentaires incluses dans le document.

optionalData2
optionalData2 string

Données non spécifiées supplémentaires incluses dans le document.

personalNumber
personalNumber string

Numéro d’identificateur secondaire du document.

placeOfBirth
placeOfBirth string

Lieu de naissance.

Cp
postcode string

Code postal d’adresse.

Restrictions
restrictions string

Restrictions de conduite.

sexe
sex string

M : Mâle F : Femelle X : Non spécifié

niveau de confiance
trustlevel string

0 : Non déterminé 1 : Document non valide 2 : Suspect 3 : Valide ce score est calculé automatiquement si l’authentification est activée.

trustnote
trustnote string
vehicleClass
vehicleClass string

Classe de véhicules sur permis de conduire.

weight
weight string

Poids de la personne.

Retours

Nom Chemin d’accès Type Description
success
success integer

Obtenir le contenu d’entrée du coffre

Lorsque des entrées sont ajoutées au coffre, l’API Core et l’API DocuPass retournent un identificateur d’entrée de coffre nommé vaultid. Vous pouvez utiliser l’identificateur pour interroger le contenu d’une entrée dans le coffre en envoyant une requête HTTP POST au point de terminaison suivant.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

pièce d'identité
id string

Identificateur d’entrée du coffre.

Retours

Nom Chemin d’accès Type Description
success
success integer
pièce d'identité
data.id string

Identificateur d’entrée du coffre

createtime
data.createtime string

Horodatage de la création d’entrée au format UTC

updatetime
data.updatetime string

Horodatage de la dernière modification au format UTC

niveau de confiance
data.trustlevel string

Ce score est calculé automatiquement si l’authentification est activée. (0 : Indéterminé, 1 : Document non valide, 2 : Suspect, 3 : Valide)

trustnote
data.trustnote string

Avertissements associés à la validité du document.

docupass_reference
data.docupass_reference string

Code de référence à la session DocuPass

docupass_success
data.docupass_success string

0 ou 1, que la vérification DocuPass ait réussi ou échoué.

docupass_failedreason
data.docupass_failedreason string

Si la vérification DocuPass a échoué, la raison pour laquelle elle a échoué.

docupass_customid
data.docupass_customid string

customid passé lors de la création de la vérification DocuPass.

documentNumber
data.documentNumber string

Identificateur unique du document (Passport No./Driver License No. etc. )

documentNumber_formatted
data.documentNumber_formatted string

Chaîne générée automatiquement de documentNumber sans symboles, ce champ est utile pour filtrer les résultats.

personalNumber
data.personalNumber string

Numéro d’identificateur secondaire du document

firstName
data.firstName string

Prénom / Nom donné

prénom
data.middleName string

Prénom(s)

lastName
data.lastName string

Nom / Nom de famille

fullName
data.fullName string

Nom complet (La mise à jour d’autres champs de nom ne met pas à jour fullName)

firstName_local
data.firstName_local string

Prénom dans la langue locale

middleName_local
data.middleName_local string

Prénom dans la langue locale

lastName_local
data.lastName_local string

Nom dans la langue locale

fullName_local
data.fullName_local string

Nom complet dans la langue locale

Dob
data.dob string

Date de naissance

Délivré
data.issued string

Date du problème

expiration
data.expiry string

Date d'expiration

sexe
data.sex string

M : Mâle, F : Femelle, X : Non spécifié

height
data.height string

Hauteur de la personne

weight
data.weight string

Poids de la personne

hairColor
data.hairColor string

Couleur des cheveux

eyeColor
data.eyeColor string

Couleur des yeux

Adresse1
data.address1 string

Ligne d’adresse 1

Adresse2
data.address2 string

Ligne d’adresse 2

Cp
data.postcode string

Code postal d’adresse

placeOfBirth
data.placeOfBirth string

Lieu de naissance

documentType
data.documentType string

P : Passport, D : Driver’s License, I : Identity Card, V : Visa, R : Residence Card, O : Other

nom_document
data.documentName string

Nom du document

vehicleClass
data.vehicleClass string

Classe de véhicules sur le permis de conduire

Restrictions
data.restrictions string

Restrictions de conduite

endossement
data.endorsement string

Approbation du permis de conduire

Messagerie électronique
data.email string

Adresse e-mail de l’utilisateur

mobile
data.mobile string

Numéro de téléphone mobile utilisateur

téléphone fixe
data.landline string

Numéro de téléphone fixe de l’utilisateur

issueAuthority
data.issueAuthority string

Autorité de problème du document

issuerOrg_region_full
data.issuerOrg_region_full string

Sous-région/état de l’émetteur de document. Exemple : Californie

issuerOrg_region_abbr
data.issuerOrg_region_abbr string

Abréviation de l’émetteur de document/état. Exemple : autorité de certification

issuerOrg_iso2
data.issuerOrg_iso2 string

Documentez le code du pays émis dans ISO2. Exemple : États-Unis

nationality_iso2
data.nationality_iso2 string

Nationalité de titulaire de documents dans ISO2. Exemple : États-Unis

optionalData
data.optionalData string

Données non spécifiées supplémentaires incluses dans le document

optionalData2
data.optionalData2 string

Données non spécifiées supplémentaires incluses dans le document

customdata1
data.customdata1 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter un mémo personnalisé à l’entrée

customdata2
data.customdata2 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter un mémo personnalisé à l’entrée

customdata3
data.customdata3 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter un mémo personnalisé à l’entrée

customdata4
data.customdata4 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter un mémo personnalisé à l’entrée

customdata5
data.customdata5 string

5 chaînes personnalisées qui peuvent être utilisées pour ajouter un mémo personnalisé à l’entrée

bloquer
data.block string

Définissez ce paramètre pour empêcher l’envoi du même document à l’API Core ou à DocuPass.

contrat
data.contract string

Lien vers des documents contractuels ou juridiques générés/signés à l’aide de l’API Core ou de DocuPass

image
data.image array of object

Contient une liste d’images associées à l’entrée.

pièce d'identité
data.image.id string

Identificateur d’image

type
data.image.type string

0 pour le document et 1 pour la personne

hash
data.image.hash string

Hachage MD5 de l’image

URL
data.image.url string

URL de l’image

createtime
data.image.createtime string

Image d’heure téléchargée au format UTC

Paramètre d’API de base

API de vérification d’ID de fonction multiple pour vérifier le document physique distant, son authenticité et son visage correspondent au document avec votre photo utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

file_base64
file_base64 string

Vous pouvez charger une image encodée en base64 sous forme de chaîne à l’aide de l’application/x-www-form-urlencoded ou application/json.

URL
url string

L’API principale est capable de télécharger une image distante à partir de votre serveur.

file_back_base64
file_back_base64 string

Image encodée en base64 du dos du document pour effectuer une analyse double côté.

url_back
url_back string

Image distante de l’arrière du document pour effectuer une analyse double côté.

face_base64
face_base64 string

Image codée en base64 du visage d’une personne pour effectuer une vérification biométrique photo.

faceurl
faceurl string

Image distante du visage d’une personne pour effectuer une vérification biométrique photo.

video_base64
video_base64 string

Vidéo d’autorécodée en base64 pour effectuer la vérification biométrique vidéo.

videourl
videourl string

Vidéo de selfie hébergée à distance pour effectuer la vérification biométrique vidéo.

code secret
passcode string

Nombre à 4 chiffres

accuracy
accuracy integer

Configurez la vitesse et la précision de la reconnaissance des documents et des résultats ocr. La précision faible réduit le temps de réponse à moins de 1 seconde, tandis que la précision élevée prend généralement 2~3 secondes.

authenticate
authenticate boolean

Validez le document pour vérifier si le document est authentique et n’a pas été falsifié.

authenticate_module
authenticate_module string

Spécifiez le module utilisé pour valider le document.

biometric_threshold
biometric_threshold float

Spécifier le score minimal pour passer la vérification biométrique faciale

return_confidence
return_confidence boolean

Retourne le score de confiance pour chaque champ de données.

return_empty
return_empty boolean

Vous pouvez obtenir que l’API retourne null sur des champs vides en activant ce paramètre.

ocr_scaledown
ocr_scaledown integer

Nombre compris entre 500 et 4000 ou 0

outputimage
outputimage boolean

Produire une image rognée du document.

outputface
outputface boolean

Produisez une image rognée de la région du visage sur le document.

outputmode
outputmode string

Affichez le document rogné et le visage sous forme d’URL ou de contenu codé en base64.

doublesidecheck
dualsidecheck boolean

Vérifiez si les noms, le numéro de document et le type de document correspondent entre l’avant et l’arrière du document lors de l’analyse double côté. Si des informations ne correspondent pas à l’erreur 14 sont levées.

verify_expiry
verify_expiry boolean

Vérifiez si le document est toujours valide en fonction de sa date d’expiration.

verify_documentno
verify_documentno string

Vérifiez si le numéro de document fourni correspond à un document.

verify_dob
verify_dob string

Vérifiez si la date de naissance fournie correspond à un document. (AAAA/MM/DD)

verify_age
verify_age string

Vérifiez si le titulaire du document est âgé entre la plage donnée. (plage, exemple : 18-40)

verify_address
verify_address string

Vérifiez si l’adresse fournie correspond au document.

verify_postcode
verify_postcode string

Vérifiez si le code postal fourni correspond à un document.

country
country string

Vérifiez si le document a été émis par les pays spécifiés, si le code d’erreur 10 n’est pas levée. Séparez plusieurs valeurs par des virgules. Par exemple, « États-Unis, CA » accepterait des documents provenant des États-Unis et du Canada.

region
region string

Vérifiez si le document a été émis par l’état spécifié, si le code d’erreur 11 n’est pas généré. Séparez plusieurs valeurs par des virgules. Par exemple, « CA, TX » accepterait des documents de Californie et du Texas.

type
type string

Vérifiez si le document était l’un des types spécifiés, si le code d’erreur 12 n’est pas levée. Par exemple, « » accepterait à la fois le passeport et le permis de conduire.

checkblocklist
checkblocklist boolean

Vérifiez les données de document par rapport aux entrées bloquées dans votre coffre. Si le document correspond à l’une des erreurs d’entrée bloquée 15 est levée

vault_save
vault_save boolean

Enregistrez l’image de document et les informations analysées dans votre coffre sécurisé. Vous pouvez répertorier, rechercher et mettre à jour des entrées de document dans votre coffre via l’API vault ou le portail web.

vault_saveunrecognized
vault_saveunrecognized boolean

Enregistrez l’image de document dans votre coffre même si le document ne peut pas être reconnu.

vault_noduplicate
vault_noduplicate boolean

Empêcher l’enregistrement des images dupliquées.

vault_automerge
vault_automerge boolean

Fusionnez automatiquement des images avec le même numéro de document en une seule entrée dans le coffre.

vault_customdata1
vault_customdata1 string

Ajoutez jusqu’à 5 chaînes personnalisées qui seront associées à l’entrée du coffre, cela peut être utile pour filtrer et rechercher des entrées.

vault_customdata2
vault_customdata2 string

Ajoutez jusqu’à 5 chaînes personnalisées qui seront associées à l’entrée du coffre, cela peut être utile pour filtrer et rechercher des entrées.

vault_customdata3
vault_customdata3 string

Ajoutez jusqu’à 5 chaînes personnalisées qui seront associées à l’entrée du coffre, cela peut être utile pour filtrer et rechercher des entrées.

vault_customdata4
vault_customdata4 string

Ajoutez jusqu’à 5 chaînes personnalisées qui seront associées à l’entrée du coffre, cela peut être utile pour filtrer et rechercher des entrées.

vault_customdata5
vault_customdata5 string

Ajoutez jusqu’à 5 chaînes personnalisées qui seront associées à l’entrée du coffre, cela peut être utile pour filtrer et rechercher des entrées.

aml_check
aml_check boolean

Vérifiez le nom et le numéro de document du titulaire du document par rapport à la base de données AML ID Analyzer.

aml_database
aml_database string

Séparez chaque code de base de données par des virgules, par exemple : un_sc,us_ofac.

aml_strict_match
aml_strict_match boolean

Activez ce paramètre pour réduire les faux positifs en ne correspondant qu’aux entités ayant exactement la même nationalité et anniversaire.

contract_generate
contract_generate string

ID de modèle de contrat pour remplir automatiquement les données utilisateur.

contract_format
contract_format string

Format du document de sortie. Facultatifs : PDF, DOCX, HTML.

contract_prefill_data
contract_prefill_data object

Retours

Nom Chemin d’accès Type Description
documentNumber
result.documentNumber string

Identificateur unique associé au document (par exemple, Passport No./Driver License No./Card Number, etc.)

personalNumber
result.personalNumber string

Identificateur personnel unique associé à la personne au sein d’un pays (par exemple, Numéro d’identification national)

firstName
result.firstName string

Prénom / Nom donné

lastName
result.lastName string

Nom / Nom de famille

prénom
result.middleName string

Prénom(s)

fullName
result.fullName string

Si le prénom et le nom ne peuvent pas être un nom complet unique sont retournés à la place

firstName_local
result.firstName_local string

Prénom dans la langue locale si disponible

lastName_local
result.lastName_local string

Nom dans la langue locale si disponible

middleName_local
result.middleName_local string

Prénom dans la langue locale si disponible

fullName_local
result.fullName_local string

Nom complet dans la langue locale si disponible

sexe
result.sex string

Gender M=Male F=Female X=Unspecified

height
result.height string

Hauteur de la personne

weight
result.weight string

Poids de la personne

hairColor
result.hairColor string

Couleur des cheveux - Code de couleur de cheveux ANSI D-20 (3 lettres)

eyeColor
result.eyeColor string

Couleur de l’œil - Code de couleur oculaire ANSI D-20 (3 lettres)

âge
result.age integer

Âge du titulaire du document

Dob
result.dob string

Date de naissance en AAAA/MM/DD

dob_day
result.dob_day integer

Date de naissance 1 à 31

dob_month
result.dob_month integer

Date de naissance du 1 à 12

dob_year
result.dob_year integer

Date de naissance de l’année de naissance en AAAA

expiration
result.expiry string

Date d’expiration du document dans AAAA/MM/DD

expiry_day
result.expiry_day integer

Jour d’expiration 1 à 31

expiry_month
result.expiry_month integer

Mois d’expiration 1 à 12

expiry_year
result.expiry_year integer

Année d’expiration en AAAA

daysToExpiry
result.daysToExpiry integer

Nombre de jours avant l’expiration du document

Délivré
result.issued string

Date du problème dans AAAA/MM/DD

issued_day
result.issued_day integer

Jour du numéro 1 à 31

issued_month
result.issued_month integer

Mois de l’émission 1 à 12

issued_year
result.issued_year integer

Année d’émission en AAAA

daysFromIssue
result.daysFromIssue integer

Nombre de jours depuis l’émission du document

Adresse1
result.address1 string

Ligne d’adresse 1

Adresse2
result.address2 string

Ligne d’adresse 2

Cp
result.postcode string

Code postal d’adresse

placeOfBirth
result.placeOfBirth string

Lieu de naissance

vehicleClass
result.vehicleClass string

Classe de véhicule de permis de conduire

Restrictions
result.restrictions string

Restrictions relatives au permis de conduire

endossement
result.endorsement string

Approbation du permis de conduire

optionalData
result.optionalData string

Données non spécifiées supplémentaires incluses dans le document

optionalData2
result.optionalData2 string

Données non spécifiées supplémentaires incluses dans le document

documentType
result.documentType string

Type de document : P=Passport, D=Driver’s License, I=Identity Card, V=Visa, R=Residence Card, O=Other

documentSide
result.documentSide string

Côté du document : FRONT, BACK ou BIODATA

issuerOrg_region_full
result.issuerOrg_region_full string

Sous-région/état de l’émetteur de document. (par exemple, Californie)

issuerOrg_region_abbr
result.issuerOrg_region_abbr string

Abréviation de l’émetteur de document/état. (par exemple, autorité de certification)

issuerOrg_full
result.issuerOrg_full string

Pays émis par le document. (Par exemple, États-Unis)

issuerOrg_iso2
result.issuerOrg_iso2 string

Documentez le code du pays émis dans ISO2. (par exemple, États-Unis)

issuerOrg_iso3
result.issuerOrg_iso3 string

Document du code de pays émis dans ISO3. (par exemple, États-Unis)

nationality_full
result.nationality_full string

Nationalité titulaire d’un document. (Par exemple, États-Unis)

nationality_iso2
result.nationality_iso2 string

Nationalité de titulaire de documents dans ISO2. (par exemple, États-Unis)

nationality_iso3
result.nationality_iso3 string

Nationalité titulaire du document dans ISO3. (par exemple, États-Unis)

internalId
result.internalId string

Utilisé pour identifier l’ID de document unique sous le système d’analyseur d’ID, le même type de document doit avoir le même ID.

documentNumber
confidence.documentNumber float

niveau de confiance de documentNumber

firstName
confidence.firstName float

niveau de confiance de firstName

lastName
confidence.lastName float

niveau de confiance du nom /nom de famille

prénom
confidence.middleName float

niveau de confiance du ou des prénoms

dob_month
confidence.dob_month float

niveau de confiance de dob_month

dob_day
confidence.dob_day float

niveau de confiance de dob_day

dob_year
confidence.dob_year float

niveau de confiance de dob_year

issued_month
confidence.issued_month float

niveau de confiance de issued_month

issued_day
confidence.issued_day float

niveau de confiance de issued_day

issued_year
confidence.issued_year float

niveau de confiance de issued_year

expiry_month
confidence.expiry_month float

niveau de confiance de expiry_month

expiry_day
confidence.expiry_day float

niveau de confiance de expiry_day

expiry_year
confidence.expiry_year float

niveau de confiance de expiry_year

sexe
confidence.sex float

niveau de confiance du sexe

height
confidence.height float

niveau de confiance de la hauteur

weight
confidence.weight float

niveau de confiance du poids

Adresse1
confidence.address1 float

niveau de confiance d’adresse1

Adresse2
confidence.address2 float

niveau de confiance de address2

Cp
confidence.postcode float

niveau de confiance du code post-code

vehicleClass
confidence.vehicleClass float

niveau de confiance de vehicleClass

Restrictions
confidence.restrictions float

niveau de confiance des restrictions

endossement
confidence.endorsement float

niveau de confiance de l’approbation

eyeColor
confidence.eyeColor float

niveau de confiance de eyeColor

âge
confidence.age float

niveau de confiance de l’âge

Dob
confidence.dob float

niveau de confiance de dob

daysToExpiry
confidence.daysToExpiry float

niveau de confiance de daysToExpiry

expiration
confidence.expiry float

niveau de confiance de l’expiration

Délivré
confidence.issued float

niveau de confiance émis

daysFromIssue
confidence.daysFromIssue float

niveau de confiance de daysFromIssue

fullName
confidence.fullName float

niveau de confiance de fullName

isIdentical
face.isIdentical boolean

Vérification biométrique réussie ou ayant échoué

confiance
face.confidence string

Valeur comprise entre 0 et 1 sur la façon dont les deux visages sont similaires, 1 étant identique.

erreur
face.error integer

Code d’erreur

error_message
face.error_message string

Message d’erreur. Exemple : Impossible de trouver des données de visage dans l’image faciale

Passé
verification.passed boolean

Si le document a passé toutes les vérifications, retourne la valeur true. Si le document a échoué au moins un type de vérification, retourne false.

visage
verification.result.face boolean

Si la vérification biométrique est activée, si le score de confiance de similarité est supérieur au seuil défini.

notexpired
verification.result.notexpired boolean

Indique si le document n’a pas encore expiré.

nom
verification.result.name boolean

Indique si le nom fourni correspond au nom analysé à partir de l’ID.

Dob
verification.result.dob boolean

Indique si l’anniversaire fourni correspond à l’anniversaire analysé à partir de l’ID.

documentNumber
verification.result.documentNumber boolean

Indique si le numéro de document fourni correspond à un numéro de document analysé à partir de l’ID.

Cp
verification.result.postcode boolean

Indique si le code postal fourni correspond à celui analysé à partir de l’ID.

address
verification.result.address boolean

Indique si l’adresse fournie correspond à l’adresse analysée à partir de l’ID.

checkdigit
verification.result.checkdigit boolean

Si le type de document a un algorithme check digit/soundex, indique si les chiffres de vérification sont valides.

âge
verification.result.age boolean

Indique si le titulaire du document se trouve dans la plage d’âge définie.

cccode
verification.result.cccode boolean

Si le type de document a une implémentation de code commercial chinois (code CC), indique si les codes CC sont valides.

score
authentication.score float

Le score sera un flotteur compris entre 0 et 1. Les documents valides auront un score plus proche de 1 tandis que les documents faux ou modifiés auront un score plus proche de 0. C’est votre discrétion de décider de la limite, un bon point de départ serait de rejeter le score inférieur à 0,5

Passé
authentication.breakdown.data_visibility.passed boolean
Passé
authentication.breakdown.image_quality.passed boolean
Passé
authentication.breakdown.feature_referencing.passed boolean
Passé
authentication.breakdown.exif_check.passed boolean
code
authentication.breakdown.exif_check.code integer
reason
authentication.breakdown.exif_check.reason string
severity
authentication.breakdown.exif_check.severity string
Passé
authentication.breakdown.publicity_check.passed boolean
code
authentication.breakdown.publicity_check.code integer
reason
authentication.breakdown.publicity_check.reason string
severity
authentication.breakdown.publicity_check.severity string
Passé
authentication.breakdown.text_analysis.passed boolean
Passé
authentication.breakdown.biometric_analysis.passed boolean
Passé
authentication.breakdown.security_feature_check.passed boolean
code
authentication.breakdown.security_feature_check.code integer
reason
authentication.breakdown.security_feature_check.reason string
severity
authentication.breakdown.security_feature_check.severity string
Passé
authentication.breakdown.recapture_check.passed boolean
code
authentication.breakdown.recapture_check.code integer
reason
authentication.breakdown.recapture_check.reason string
severity
authentication.breakdown.recapture_check.severity string
warning
authentication.warning array of string

Tableau de chaîne contenant des messages d’avertissement sur la validité du document.

aml
aml array of object

Tableau contenant la liste des correspondances AML, retourne un tableau vide si aucune correspondance n’a été trouvée. Pour plus d’informations, reportez-vous à la référence de l’API AML.

Entité
aml.entity string

personne ou droit

fullname
aml.fullname array of string

Nom(s) d’entité juridique ou de personne

prénom
aml.firstname array of string

Prénom(s) de la personne

nom de famille
aml.lastname array of string

Nom(s) de la personne

middlename
aml.middlename array of string

Prénom(s) de la personne

alias
aml.alias array of string

Autre ou nom(s) étranger(s) de l’entité

Dob
aml.dob array of string

L’anniversaire de Peron pourrait venir dans les formats AAAA, AAAA-MM ou AAAA-MM-DD.

address
aml.address array of string

Adresse ou pays résidant de l’entité

nationalité
aml.nationality array of string

Pays ou nationalité de l’entité

lieu de naissance
aml.birthplace array of string

Naissance de Peron

gender
aml.gender array of string

Sexe de Peron : M ou F

documentnumber
aml.documentnumber array of object

Liste des documents associés à l’entité.

pièce d'identité
aml.documentnumber.id string

Numéro de document

id_formatted
aml.documentnumber.id_formatted string

Numéro de document alphanumérique

country
aml.documentnumber.country string

Code de pays ISO2

type
aml.documentnumber.type string

P = Numéro de passeport, I = Numéro d’ID, D = Numéro de permis de conduire, O = Type de document Other/Unknown

programme
aml.program array of string

Programme de sanction

note
aml.note array of string

Remarque supplémentaire pour l’entité

time
aml.time string

Horodatage TZ UTC lorsque l’entité a été ajoutée à la liste source ou à la dernière mise à jour

status
aml.status string

Position/titre de l’entité ou état actuel de la sanction

Source
aml.source array of string

Liste des URL de source officielle

base de données
aml.database string

Code de base de données AML d’ID Analyzer

schéma
aml.schema string
document_url
contract.document_url string

URL du document généré

erreur
contract.error string

Si le contrat n’a pas pu être généré, ce champ contient une raison telle que « ID de modèle de contrat non valide ».

vaultid
vaultid string

Identificateur unique de l’entrée du coffre si vault_save est activé.

matchrate
matchrate float

Le ratio des champs correctement reconnus par l’API indique que l’image du document est trop floue.

output
output string

Si outputimage est défini sur true et que outputmode est url, ce champ inclut une URL (ou un tableau d’URL pour l’analyse double côté) pointant vers l’image de document rognée. Le lien est garanti uniquement pendant 600 secondes et sera supprimé à tout moment après.

outputface
outputface string

Si la sortie est définie sur true et que outputmode est url, ce champ inclut une URL pointant vers l’image de visage rognée. Le lien est garanti uniquement pendant 600 secondes et sera supprimé à tout moment après.

Recadrée
cropped string

Si outputimage est défini sur true et que le mode de sortie est base64, ce champ inclut une image codée en base64 (ou un tableau d’images codées en base64 pour l’analyse double côté) du document rogné au format JPEG

croppedface
croppedface string

Si la sortie est définie sur true et que le mode de sortie est base64, ce champ inclut une image codée en base64 de la région de visage rognée du document au format JPEG.

executionTime
executionTime float

Temps nécessaire pour l’opération d’API en secondes.

responseID
responseID string

Identificateur unique pour identifier la demande/réponse.

quota
quota integer

Quota d’API restant, réinitialise au début de chaque mois pour un abonné gratuit ou annuel, ou au début de chaque cycle de facturation pour l’abonné mensuel. Si vous disposez d’un plan d’abonnement, votre quota mensuel sera utilisé avant votre crédit.

crédits
credit integer

Crédit de test restant pour votre compte. Si vous disposez d’un plan d’abonnement, votre quota mensuel sera utilisé avant votre crédit.

Recherche de base de données AML

L’API AML vous permet de rechercher dans la base de données AML globale ID Analyzer des sanctions, des PPE et des criminels recherchés à l’aide d’un nom, d’un numéro de document ou des deux. Vous pouvez filtrer davantage les résultats avec anniversaire et nationalité.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

nom
name string

Nom ou alias de la personne ou de l’organisation dans n’importe quelle langue.

documentnumber
documentnumber string

Numéro de passeport de la personne, numéro d’identification national ou numéro de permis de conduire, etc.

Entité
entity string

personne : personne ; légalité : entreprise ou organisation

country
country string

Retournez uniquement les entités avec pays/nationalité correspondant ou aucune information sur le pays.

Dob
dob string

Renvoyer uniquement les entités avec anniversaire correspondant ou aucune information d’anniversaire.

base de données
database string

Spécifiez les bases de données sources pour effectuer une vérification AML, si elles sont vides, toutes les bases de données sources seront vérifiées. Séparez chaque code de base de données par des virgules, par exemple : un_sc,us_ofac. Pour obtenir la liste complète des bases de données sources et du code correspondant, consultez la vue d’ensemble de l’API AML.

Retours

Nom Chemin d’accès Type Description
aml
items array of object

Tableau contenant la liste des correspondances AML, retourne un tableau vide si aucune correspondance n’a été trouvée. Pour plus d’informations, reportez-vous à la référence de l’API AML.

Entité
items.entity string

personne ou droit

fullname
items.fullname array of string

Nom(s) d’entité juridique ou de personne

prénom
items.firstname array of string

Prénom(s) de la personne

nom de famille
items.lastname array of string

Nom(s) de la personne

middlename
items.middlename array of string

Prénom(s) de la personne

alias
items.alias array of string

Autre ou nom(s) étranger(s) de l’entité

Dob
items.dob array of string

L’anniversaire de Peron pourrait venir dans les formats AAAA, AAAA-MM ou AAAA-MM-DD.

address
items.address array of string

Adresse ou pays résidant de l’entité

nationalité
items.nationality array of string

Pays ou nationalité de l’entité

lieu de naissance
items.birthplace array of string

Naissance de Peron

gender
items.gender array of string

Sexe de Peron : M ou F

documentnumber
items.documentnumber array of object

Liste des documents associés à l’entité.

pièce d'identité
items.documentnumber.id string

Numéro de document

id_formatted
items.documentnumber.id_formatted string

Numéro de document alphanumérique

country
items.documentnumber.country string

Code de pays ISO2

type
items.documentnumber.type string

P = Numéro de passeport, I = Numéro d’ID, D = Numéro de permis de conduire, O = Type de document Other/Unknown

programme
items.program array of string

Programme de sanction

note
items.note array of string

Remarque supplémentaire pour l’entité

time
items.time string

Horodatage TZ UTC lorsque l’entité a été ajoutée à la liste source ou à la dernière mise à jour

status
items.status string

Position/titre de l’entité ou état actuel de la sanction

Source
items.source array of string

Liste des URL de source officielle

base de données
items.database string

Code de base de données AML d’ID Analyzer

schéma
items.schema string

Recherche de visages

La recherche de visages vous permet de rechercher l’intégralité du coffre à l’aide d’une image d’une personne. Pour utiliser la fonctionnalité de recherche de visages, vous devez activer l’indexation de recherche de visages sous le portail web et entraîner régulièrement vos jeux de données de coffre.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

image
image string

Données d’image encodées en base64.

imageurl
imageurl string

URL de l’image distante.

maxentry
maxentry integer

Nombre d’entrées correspondantes à retourner, comprises entre 1 et 10.

threshold
threshold float

Définissez le score de similarité minimale des visages requis, dans la plage de 0 à 1.

Retours

Nom Chemin d’accès Type Description
items
items array of

Si des entrées correspondantes sont trouvées, une liste de documents avec contenu complet est retournée comme la commande de liste.

Supprimer l’entrée du coffre

Vous pouvez supprimer des entrées de coffre uniques ou multiples en effectuant une requête HTTP POST.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

pièce d'identité
id True array of string

pièce d'identité

Retours

Nom Chemin d’accès Type Description
success
success integer

Supprimer une image du coffre

Vous pouvez supprimer une image à l’intérieur d’une entrée de coffre en effectuant une requête HTTP POST. Notez qu’après la suppression d’une image, l’URL de l’image peut toujours être accessible pendant une courte période en raison de la mise en cache.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

pièce d'identité
id True string

Identificateur d’entrée du coffre contenant l’image.

imageid
imageid string

ID de l’image à supprimer.

Retours

Nom Chemin d’accès Type Description
success
success integer

Validation du rappel

Pour vous assurer que les données ont été envoyées à partir de notre serveur.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

référence
reference True string

Code de référence reçu dans POST BODY.

hash
hash True string

Hachage reçu dans POST BODY.

Retours

Nom Chemin d’accès Type Description
success
success boolean
référence
reference string

Code de référence pour la session DocuPass

État de l’entraînement

Vérifiez si la formation du coffre est toujours en cours ou s’est terminée.

Paramètres

Nom Clé Obligatoire Type Description
apikey
apikey True string

Votre clé API privée est disponible sous votre portail web.

Retours

Nom Chemin d’accès Type Description
status
status string

nottrained : Jamais formé, non démarré : L’entraînement n’est pas en cours d’exécution, en cours d’exécution : L’entraînement est en cours d’exécution, réussi : Échec de l’entraînement : Échec de l’entraînement

startTime
startTime string

Heure de début de la dernière formation au format UTC.

statusChangeTime
statusChangeTime string

Heure du dernier changement d’état au format UTC.

lastSuccessTime
lastSuccessTime string

Heure de la dernière formation réussie au format UTC.

erreur
error string

Message d’erreur associé à l’état d’entraînement ayant échoué.