API Ressources
Qu’est ce que l’API Ressources ?
L’API Ressources est conçue pour valider des justificatifs de ressources sous forme d’appels API, en se basant sur les informations issues du document ou des éléments de sécurité tels que les codes 2D-Doc
Les documents sont envoyés sous forme de documents PDF, traités par reconnaissance de caractères (OCR) permettant d’en extraire les données.
Cette méthode permet de :
- croiser les informations
- valider les informations
- valider les clés de contrôle
Et ce en quelques secondes !
Documents acceptés
Le service est actuellement compatible avec les documents français suivants :
- fiche de paie fonctionnaire (avec le code 2D-Doc)
- attestation de paiement de la CAF (RSA, allocations etc)
- impots sur les revenus
Application web
L’API est accompagnée d’une application web vous permettant de :
- Visualiser votre abonnement / savoir combien il vous reste de vérifications
- Voir l’historique de vos appels API
- Télécharger les rapports PDF, JSON et XML pour chaque appel de l’historique
- Supprimer les données
- Accéder à l’outil “Vérifier un document” permettant de vérifier un justificatif de ressources en envoyant le fichier directement depuis l’interface web
Et ce localisé en FR / EN.
Comment souscrire ?
L’API ressources est disponible avec l’ensemble des abonnements Ressources (mais pas avec le paiement ponctuel).
Il suffit de souscrire à l’un des abonnements pour recevoir un email de création de compte avec :
- votre clé API
- les identifiants et mot de passe vous permettant d’accéder à l’application web
(Vérifiez dans les spams quelques minutes après souscription si vous n’avez pas reçu l’email d’activation).
Outil « Vérifier un document »
Envoyez directement les documents à vérifier depuis l’interface web !
Avec l’onglet « Vérifier un document », vous pouvez envoyer les fichiers à vérifier sans passer par des appels API !
Les résultats seront ensuite disponibles dans l’historique, avec téléchargement possible sous forme de rapport PDF, JSON ou XML.
Comment envoyer les documents ?
Le format accepté est le format PDF.
Fonctionnalités
L’API Ressources vous permet :
- D’extraire les données des documents
- De vérifier la véracités des informations extraites en les croisant avec celles présentes sur le document
- De s’assurer de la validité des points suivants :
- Nom complet
- Dates de début et fin de période
- Revenus nets mensuels
- Cumul net annuel
- Date de signature
- Nombre de parts du foyer fiscal
- Revenus fical de référence
- Année des revenus
- Déclarants
- Dates de validité du certificat de signature numérique
- Emetteur du certificat de signature numérique
- Validité du certificat de signature numérique