Définition de l'objet
Vérification d'identité
PersonIdentityVerification
Les propriétés d'une fiche « Vérification d'identité », ses énumérations et ses liaisons avec les autres fiches.
Une fiche « Vérification d'identité », telle que l'API la lit et l'écrit (PersonIdentityVerification dans la référence). Sa liste et sa création : https://staging-api.docage.com/PersonIdentityVerifications ; une fiche : https://staging-api.docage.com/PersonIdentityVerifications/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.
Ses propriétés
AcceptInReviewoui ou nonAccepter une vérification en revue
Checksliste dePersonIdentityCheckContrôles demandés
ConsentAcceptedAtUtcdate et heure (UTC)Écrite par le serveurDate du consentement biométrique
DateOfBirthtexteÉcrite par le serveurDate de naissance lue
DecidedAtUtcdate et heure (UTC)Écrite par le serveurDate de la décision
Motif de refus
DocumentExpirationDatetexteÉcrite par le serveurDate d'expiration de la pièce
DocumentNumberLast4texte, 4 caractères au plusÉcrite par le serveurFin du numéro de pièce
Type de pièce
ExpectedEmailtexte, 255 caractères au plusEmail attendu
ExpectedFirstNametexte, 255 caractères au plusPrénom attendu
ExpectedLastNametexte, 255 caractères au plusNom attendu
ExpiresAtUtcdate et heure (UTC)Écrite par le serveurDate d'expiration
FaceMatchScorenombreÉcrite par le serveurScore de comparaison faciale
Contrôles non réussis
FallbackValidityDaysentierJours de validité de secours
FirstNametexte, 255 caractères au plusÉcrite par le serveurPrénom lu
Instancesliste dePersonIdentityVerificationVérifications issues de ce modèle
IsDecidedoui ou nonVrai quand le fournisseur a rendu son verdict : approuvée ou refusée. Ni expirée ni abandonnée, qui ne sont pas des verdicts.
IsReuseoui ou nonVrai quand cette vérification est une réutilisation d'une vérification d'origine — elle ne porte alors ni rapport ni résumé de pièce.
IsTerminaloui ou nonVrai quand plus rien n'arrivera du fournisseur pour cette session.
IssuingCountrytexte, 2 caractères au plusÉcrite par le serveurPays émetteur
LastNametexte, 255 caractères au plusÉcrite par le serveurNom lu
LinktexteLien de vérification
LivenessScorenombreÉcrite par le serveurScore de vivant
NameMatchoui ou nonÉcrite par le serveurNom correspondant
NeedsConsentoui ou nonVrai tant que le consentement biométrique n'a pas été donné : aucune session ne se crée avant. Une vérification qui ne lit QUE la pièce n'est pas un traitement biométrique : elle n'en demande aucun — l'écran, le script et le démarrage lisent tous cette propriété.
Origine
Contrôles effectués
PersonIdentityIdidentifiantÉcrite par le serveurIdentifiant de l'identité
ProviderSessionIdtexte, 255 caractères au plusÉcrite par le serveurIdentifiant de la session chez le fournisseur
ProviderStatustexte, 100 caractères au plusÉcrite par le serveurStatut chez le fournisseur
PurgedAtUtcdate et heure (UTC)Écrite par le serveurDate de purge
ReportFileIdidentifiantÉcrite par le serveurIdentifiant du rapport
RequireNameMatchoui ou nonExiger la correspondance du nom
RetentionDaysentierJours de rétention
ReuseIdentityFromOtherOrganizationsoui ou nonRéutiliser une identité vérifiée par une autre organisation
ReuseSecurityCodeIdidentifiantÉcrite par le serveurIdentifiant du code de réutilisation
ReuseValidIdentityoui ou nonRéutiliser une identité valide
SourceVerificationIdidentifiantÉcrite par le serveurIdentifiant de la vérification d'origine
StartedAtUtcdate et heure (UTC)Écrite par le serveurDate de début
Statut
StatusDetailstexteÉcrite par le serveurDétails du statut
TemplatePersonIdentityVerificationLe modèle dont cette vérification est issue.
TransactionActionIdidentifiantÉcrite par le serveurIdentifiant de l'action de parcours
TransactionIdidentifiantÉcrite par le serveurIdentifiant du parcours
AddToBoxIdsliste d'identifiantsIdentifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentierDurée d'archivage en années
BoxIdsliste d'identifiantsLecture seuleIdentifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveurDate de création
Créateur
CreationUserIdidentifiantÉcrite par le serveurIdentifiant du créateur
CultureInfotexteCulture
CustomFieldsliste deFieldLes champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste deFieldChamps personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste deFieldChamps personnalisés de l'organisation
CustomFieldsFromTemplateliste deFieldChamps personnalisés du modèle
CustomFieldsUserDataliste deFieldUserDataValeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveurDate de suppression
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveurIdentifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusionSi une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seuleEtat de l'entité
ExternalIdtexte, 128 caractères au plusIdentifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveurCampagne ayant généré l'entité
GeneratedByFormIdidentifiantIdentifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveurIdentifiant
IsArchivedoui ou nonArchivé
IsSystemoui ou nonÉcrite par le serveurEst système
IsTemplateoui ou nonLecture seuleEst un modèle
LanguageLanguageLangue
LastModificationDatedate et heure (UTC)Écrite par le serveurDate de modification
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveurIdentifiant du dernier modificateur
MergeEntitiesliste deMergeEntityObjets participant à la fusion
MergeFieldsliste deMergeFieldChamps de fusion
MustBeArchivedoui ou nonDate de début d'archivage
Nametexte, 255 caractères au plusNom
NotestexteNotes
ParentOrganizationIdidentifiantLecture seuleOrganisation parente
ParentRightsDTOliste deRightDTOLes nouveaux droits de la fiche, à sa création ou à sa mise à jour : la liste REMPLACE ses droits, elle doit donc contenir tous les nouveaux droits. Réservé à qui administre la fiche : pouvoir la modifier ne suffit pas.
RelationDefinitionsForInstancesliste deRelationDefinitionLes relations déclarées sur ce modèle : une extrémité est imposée (le modèle lui-même), et la relation ne vaut que pour ses instances — en plus de celles déclarées au niveau de l'organisation dont une extrémité est du même type. Elles se propagent comme CustomFieldsForInstances : une instance les lit dans RelationDefinitionsFromTemplate.
RelationDefinitionsFromTemplateliste deRelationDefinitionLes relations qu'une instance tient de son modèle. Elles ne sont pas recopiées : elles se relisent sur le modèle à chaque lecture. Ajouter une relation sur un modèle la fait donc apparaître sur toutes ses instances existantes, y compris celles créées avant, comme un champ personnalisé (CustomFieldsFromTemplate).
RemoveFromBoxIdsliste d'identifiantsIdentifiants des classeurs à délier de l'entité
TemplateIdidentifiantIdentifiant de Modèle utilisé
Aucune propriété ne correspond.
Ses énumérations
PersonIdentityCheck
- 1Pièce d'identité
- 2Détection du vivant
- 3Comparaison faciale
PersonIdentityDeclineReason
- 1Pièce rejetée
- 2Pièce expirée
- 3Détection du vivant en échec
- 4Visage différent
- 5Nom différent
- 99Autre
IdentityDocumentType
- 1Carte d'identité
- 2Passeport
- 3Titre de séjour
- 4Permis de conduire
- 99Autre
IdentityVerificationOrigin
- 1Utilisateur
- 2Parcours
- 4Flux
- 5Email
- 6Planifiée
IdentityVerificationStatus
- -100Erreur
- 0Brouillon
- 1Non commencée
- 2En cours
- 3En revue
- 4Approuvée
- 5Refusée
- 6Expirée
- 7Abandonnée
Ses liaisons
Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans
une liste (voir Lire des listes).