Documentation suite web ressources
Qu’est ce que la suite web ressources?
Vous trouverez un descriptif général exhaustif sur la page produit suite web ressources.
Comment envoyer les documents ?
Formats acceptés
Le format accepté est le format PDF.
Nombre de pages par appel
Le nombre de fichier acceptés dépend du type de document :
– impôt sur les revenus FR : 1 seul fichier
– fiche de paie fonctionnaire FR : 1 seul fichier
– attestation de paiement CAF FR : plusieurs fichiers
Interface web
Elément central de la suite, l’interface web vous permet de :
– Voir les détails de votre abonnement
– Savoir combien il vous reste de vérifications sur chaque abonnement
– Accéder à l’historique de vos appels API
– Télécharger les rapports JSON et XML de chaque appel de l’historique
– Supprimer les données correspondantes
Langues disponibles
L’interface web est disponibles dans les langues suivantes :
– Français
– Anglais
Onglet abonnements
Vous trouverez la liste de vos abonnements sur la page d’accueil de l’interface web, avec les informations suivantes :
– Type de plan (PRO, BUSINESS, CORPORATE ou SINGLE_PAYMENT)
– Périodicité (mensuelle ou annuelle, non disponible pour les SINGLE_PAYMENT)
– Souscription active : est-ce que votre abonnement est actif ou non
– Date de renouvellement / fin d’abonnement
– Vérifications restantes : nombre de vérifications restantes sur votre abonnement, sur la période
Onglet ressources
L’onglet ressources (accessible si un abonnement Ressources est actif) vous permet d’accéder à différentes informations et outils.
Historique
L’historique des appels API vous permet de connaitre l’historique complet des appels réalisés, avec les informations suivantes :
- date de l’analyse
- type de document vérifié
- téléchargement du rapport aux formats PDF / JSON / XML
- Suppression de l’analyse et des données correspondantes
Outil “Vérifier un document”
L’outil “Vérifier un document” vous permet d’envoyez directement les documents à vérifier depuis l’interface web.
Le nombre de fichiers qu’il est possible d’envoyer (par envoi) est différent selon les documents :
- impôt sur les revenus : 1 seul fichier
- fiche de paie fonctionnaire : 1 seul fichier
- avis de paiement CAF : plusieurs fichiers
Les résultats seront ensuite disponibles dans l’historique, avec téléchargement possible sous forme de rapport PDF, JSON ou XML.
Erreurs possibles
Document non reconnu
Cette erreur vous indique que le document n’a pas pu être reconnu.
Vérifiez les points suivants :
- Le format correspond au format indiqué dans la documentation
- Le document correspond à l’un des documents compatibles avec le service
- Le document est lisible
Plus de crédits disponibles
Cette erreur vous indique que vous n’avez plus de crédits disponible.
Il convient alors de souscrire un nouvel abonnement, ou d’acheter de nouvelles vérifications via les single payments.
Vérifications effectuées sur chaque type de document
Vous trouverez ci dessous la liste ainsi que le descriptif des différents champs et vérifications effectuées sur chacun des type de documents d’identité compatible avec nos produits.
Vous trouverez ci dessous la liste ainsi que le descriptif des différents champs et vérifications effectuées sur chacun des type de documents d’identité compatible avec nos produits.
Impôt sur les revenus
Impôt sur les revenus
| Nom du paramètre | Type | Description |
|---|---|---|
| documentInfos | | |
| publicationDate | String | Date de publication (peut être null) |
| signatureDate | String | Date de signature du document |
| taxableIncomeReference | String | Revenu fiscal de référence |
| sharesNumber | String | Nombre de parts du foyer fiscal |
| noticeReference | String | Référence de l’avis |
| incomeYear | String | Année des revenus |
| declarant1 | String | Déclarant 1 |
| taxNumberDeclarant1 | String | Numéro fiscal déclarant 1 |
| declarant2 | String | Déclarant 2 |
| taxNumberDeclarant2 | String | Numéro fiscal déclarant 2 |
| collectionDate | String | Date de prélèvement |
| certificate | | |
| validityStartDate | String | Date de début de validité du certificat de signature numérique |
| validityEndDate | String | Date de fin de validité du certificat de signature numérique |
| issuerReference | String | Référence émetteur du certificat de signature numérique |
| issuerName | String | Nom de l’émetteur du certificat de signature numérique |
| subjectReference | String | Référence sujet du certificat de signature numérique |
| issuer | String | Emetteur du certificat de signature numérique |
| datesConsistency | Boolean | Est-ce que les dates de début et fin de validité sont cohérentes avec la date d’émission du document ? |
| digitalSignature | Boolean | Est-ce que le certificat de signature numérique est valide ? |
Fiche de paie fonctionnaire
Fiche de paie fonctionnaire
| Nom du paramètre | Type | Description |
|---|---|---|
| documentInfos | ||
| fullName | String | Nom complet (Nom et prénom) du bénéficiaire |
| employerSiret | String | SIRET de l’employeur |
| periodStartDate | String | Date de début de période du document |
| periodEndDate | String | Date de fin de période du document |
| contractStartDate | Array | Date de début de contrat du bénéficiaire (n’est pas souvent renseigné) |
| netTaxableSalary | String | Salaire net du mois |
| netTaxableAccumulatedSalary | String | Cumul net de l’année |
| certificate | ||
| validityStartDate | String | Date de début de validité du certificat de signature numérique |
| validityEndDate | String | Date de fin de validité du certificat de signature numérique |
| issuerReference | String | Référence émetteur du certificat de signature numérique |
| issuerName | String | Nom de l’émetteur du certificat de signature numérique |
| subjectReference | String | Référence sujet du certificat de signature numérique |
| issuer | String | Emetteur du certificat de signature numérique |
| datesConsistency | Boolean | Est-ce que les dates de début et fin de validité sont cohérentes avec la date d’émission du document ? |
| digitalSignature | Boolean | Est-ce que le certificat de signature numérique est valide ? |
Attestation de paiement CAF (1 seul fichier)
Attestation de paiement CAF (1 seul fichier)
| Nom du paramètre | Type | Description |
|---|---|---|
| documentInfos | ||
| documentDate | String | Date du document |
| dateOfBirth | String | Date de naissance du bénéficiaire |
| numberOfPages | String | Nombre de page du fichier |
| beneficiaryNumberHeader | String | Numéro allocataire de l’entête |
| dateHourFooter | String | Dates et heures du bas de page |
| barcodeNumber | String | Numéro sous le code barre |
| barcodeNumberDecoded | String | Numéro du code barre décodé |
| documentInfosValidation | ||
| datesHeaderFooterValid | Boolean | Dates cohérentes entre l’entête et le bas de page ? |
| beneficiaryNumberHeaderFooterValid | Boolean | Numéro allocataire cohérent entre l’entête et le bas de page ? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Numéro allocataire cohérent entre l’entête et le numéro sous le code barre ? |
| barcodeNumberBarcodeValid | Boolean | Numéro sous le code barre et numéro de code barre décodé cohérents ? |
| datesHeaderMetasValid | Boolean | Dates dans l’entête et dans les métas cohérentes ? |
| datesFooterMetasValid | Boolean | Dates dans le bas de page et dans les métas cohérentes ? |
Attestation de paiement CAF (plusieurs fichiers)
Attestation de paiement CAF (plusieurs fichiers)
| Nom du paramètre | Type | Description |
|---|---|---|
| documentInfos | ||
| documentDate | String | Date du document |
| dateOfBirth | String | Date de naissance du bénéficiaire |
| numberOfPages | String | Nombre de page du fichier |
| beneficiaryNumberHeader | String | Numéro allocataire de l’entête |
| dateHourFooter | String | Dates et heures du bas de page |
| barcodeNumber | String | Numéro sous le code barre |
| barcodeNumberDecoded | String | Numéro du code barre décodé |
| documentInfosValidation | ||
| datesHeaderFooterValid | Boolean | Dates cohérentes entre l’entête et le bas de page ? |
| beneficiaryNumberHeaderFooterValid | Boolean | Numéro allocataire cohérent entre l’entête et le bas de page ? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Numéro allocataire cohérent entre l’entête et le numéro sous le code barre ? |
| barcodeNumberBarcodeValid | Boolean | Numéro sous le code barre et numéro de code barre décodé cohérents ? |
| datesHeaderMetasValid | Boolean | Dates dans l’entête et dans les métas cohérentes ? |
| datesFooterMetasValid | Boolean | Dates dans le bas de page et dans les métas cohérentes ? |
| documentsValidation | ||
| datesOfBirthValid | Boolean | Dates de naissance cohérentes entre les fichiers ? |
| datesHeaderFooterValid | Boolean | Dates entête et bas de page cohérentes entre les fichiers ? |
| beneficiaryNumberHeaderFooterValid | Boolean | Numéros allocataires entête et bas de page cohérents entre les fichiers ? |
| beneficiaryNumberBarcodeNumberValid | Boolean | Numéro allocataire cohérent entre l’entête et le numéro sous le code barre entre les fichiers ? |
| barcodeNumberBarcodeValid | Boolean | Numéro sous le code barre et numéro de code barre décodé cohérents entre les fichiers ? |
| datesHeaderMetasValid | Boolean | Dates dans l’entête et dans les métas cohérentes entre les fichiers ? |
| datesFooterMetasValid | Boolean | Dates dans le bas de page et dans les métas cohérentes entre les fichiers ? |
| modificationDateMetasValid | Boolean | Est-ce que la date de modification des balises métas du document PDF est nulle ? |