Resources API
What is the Resources API?
The Resources API is designed to validate resource credentials as API calls, based on information from the document or security elements such as 2D-Doc codes
The documents are sent as PDF documents, processed by character recognition (OCR) to extract the data.
This method makes it possible to:
- Cross-referencing information
- Validate information
- Validate control keys
And this in a few seconds!
Accepted documents
The service is currently compatible with the following French documents:
- civil servant pay slip (with the code 2D-Doc)
- certificate of payment of the CAF (RSA, allowances etc)
- Income taxes
Web application
The API comes with a web application that allows you to:
- View your subscription / find out how many verifications you have left
- View your API call history
- Download PDF, JSON, and XML reports for each call in the history
- Delete data
- Access the “Verify a document” tool to verify a proof of resources by sending the file directly from the web interface
And this is located in FR / EN.
How to subscribe?
The Resources API is available with all Resource subscriptions (but not with one-time payment).
Simply subscribe to one of the subscriptions to receive an account creation email with:
- your API key
- The username and password allowing you to access the web application
(Check in spam a few minutes after subscribing if you have not received the activation email).
Documentation
The documentation presents the details of the API and allows for an easy and quick getting started for developers.
Price
Find the subscription that best suits your needs from the three available API resource plans!
Free Trial
Request a 10-day free trial to test all the features of our API!
Tool "Verify a document"
Send the documents to be checked directly from the web interface!
With the “Verify Document” tab, you can send the files to be verified without going through API calls!
The results will then be available in the history, which can be downloaded as a PDF, JSON or XML report.
How do I send the documents?
Accepted formats
The accepted format is PDF.
Features
The Resources API allows you to:
- Extract data from documents
- Verify the veracity of the information extracted by cross-referencing it with that present on the document
- To ensure the validity of the following points:
- Full name
- Start and end dates of period
- Monthly net income
- Year-to-date
- Signature date
- Number of shares in the tax household
- Benchmark income
- Year of income
- Reporting
- Digital Signature Certificate Validity Dates
- Digital Signature Certificate Issuer
- Digital Signature Certificate Validity
