PAD
- Purpose: Guide to quickly start using the PAD (Automatic Document Processing) API.
- Description: Automates the extraction of information into structured data, applicable to forms, documents, invoices, receipts, personal identity cards, passports, driverâs licenses, and other custom documents of interest, using internal AI/ML models.
Prerequisites
- You will need to have API credentials from your organization
- Your account should have at least the roles:
padandusage.
PAD flow
Basic data extraction flow from a document:
- The client sends a POST request to the PAD API at the /analyze endpoint.
- The PAD API creates a log USAGE record of the request.
- The PAD API applies validations to the incoming data.
- The PAD API performs JSON parsing of the validated data.
- The PAD API sends a success response back to the client.
Usage
| Files formats allowed | Files Maximum size |
|---|---|
| 500 MB | |
Images format: PNG, BMP, JPEG/JPG | 500 MB |
Available models
Payroll
Payroll refers to the process of calculating and distributing wages, salaries, and other forms of compensation to employees for their work. It involves determining the amount of pay based on hours worked, salary rates, and any deductions such as taxes, benefits, and retirement contributions. Payroll ensures compliance with labor laws and tax regulations, and it is crucial for maintaining accurate records of employee compensation.
Document type: payroll
| Label | Type | Slug |
|---|---|---|
| Full name | text | py:fullname |
| Personal ID | text | wl:nif |
| Net pay | numeric | py:net-pay |
| Seniority | date | py:seniority |
| Period | period | py:period |
Working Life Document
A Working Life Document is a record that outlines an individualâs employment history, career progression, and professional achievements. It typically includes details such as job titles, responsibilities, skills acquired, training, and significant milestones throughout an employeeâs career. This document serves as a comprehensive summary of a personâs professional life, often used for job applications, performance reviews, or career development.
Document type: working-life-document
| Label | Type | Slug |
|---|---|---|
| Document date | date | wl:document-date |
| Full name | text | wl:fullname |
| Personal ID | text | wl:nif |
| Company name | text | wl:company-name |
| Enrollment date | date | wl:enrollment-date |
| Termination date | date | wl:termination-date |
| Number of days of registration in the Social Security System | text | wl:number-days-registration |
| Type of Employment Contract | text | wl:type |
Income Document
An Income Document is a record that provides detailed information about an individualâs earnings over a specific period. It includes sources of income such as salary, wages, bonuses, commissions, or freelance payments. This document is commonly used for financial reporting, loan applications, tax filings, and proof of income verification. It serves as evidence of an individualâs financial stability and earning capacity.
Document type: income-document
| Label | Type | Slug |
|---|---|---|
| Full name | text | in:fullname |
| NIF | text | in:nif |
| Year of fiscal year | text | in:year-fiscal |
| Reduced net income | text | in:reduced-net-income |
| Date of birth | date | in:birthdate |
| Nationality | text | in:nationality |
| Validity | date | in:validity |
| Single | selectionMark | in:marital-single |
| Married | selectionMark | in:marital-married |
| Widowed | selectionMark | in:marital-widowed |
| Divorced | selectionMark | in:marital-divorced |
Obverse Side of National Identity Card
The obverse side of a National Identity Card typically features essential personal information about the cardholder, such as their full name, photograph, date of birth, nationality, and a unique identification number. It may also include additional details like the cardholderâs signature, address, and the issuing authority. This side of the card serves as the primary reference for verifying an individualâs identity.
Document type: obverse-dni
| Label | Type | Slug |
|---|---|---|
| Personal ID | text | od:personal-id |
| Names | text | od:names |
| Surnames | text | od:Surnames |
| Gender | text | od:gender |
| Date of birth | date | od:birthplace |
| Nationality | text | od:nationality |
| Validity | date | od:validity |
Reverse Side of National Identity Card
The reverse side of a National Identity Card often includes additional details such as the cardholderâs address, barcode or magnetic strip for electronic verification, and security features like holograms or microprints to prevent fraud. It may also contain other information required by the issuing authority, such as expiration date, endorsements, or a machine-readable zone for automated processing. This side complements the obverse in ensuring the cardâs authenticity and usability.
Document type: reverse-dni
| Label | Type | Slug |
|---|---|---|
| First row MRZ | mrz | rd:first-row |
| Second row MRZ | mrz | rd:second-row |
| Third row MRZ | mrz | rd:third-row |
Panamanian DNI
The Panamanian DNI (National Identity Document) is an official identification card issued to citizens of Panama. It includes personal information such as the holderâs name, photograph, date of birth, and a unique identification number. The card serves as proof of identity for various administrative and legal purposes within the country. It also features security elements to prevent fraud and is used for voting, accessing public services, and conducting official transactions.
Document type: panamanian-dni
| Label | Type | Slug |
|---|---|---|
| Common name | text | pi:common-name |
| Date of birth | date | pi:date-birth |
| Gender | text | pi:gender |
| Donor | text | pi:donor |
| Blood type | text | pi:blood-type |
| Issued | date | pi:issued |
| Expires | date | pi:expires |
| Personal identity | text | pi:dni |
Maritime Migration Registration Voucher
The Maritime Migration Registration Voucher is an official document issued to individuals involved in maritime migration. It serves as proof of registration for those entering or leaving a country via maritime routes. This voucher typically includes personal details, travel information, and specific migration status. It is used to ensure proper documentation and legal compliance for maritime migrants and may be required for customs, immigration, and border control procedures.
Document type: maritime-migration-coupon
| Label | Type | Slug |
|---|---|---|
| Notebook number | text | mc:notebook-number |
| Value | money | mc:value |
| Ship | text | mc:ship |
| Shipping agency stamp | text | mc:shipping-agency-stamp |
| Receipt number | text | mc:receipt-number |
| Date of execution | date | mc:execution-date |
| Embark | selectionMark | mc:embark |
| Receipt | selectionMark | mc:receipt |
| Disembark | selectionMark | mc:disembark |
| Dispatch | selectionMark | mc:dispatch |
Personal Documents
Personal documents are official papers that provide essential information about an individualâs identity, legal status, and personal history. These documents include items such as passports, national IDs, birth certificates, marriage certificates, and social security cards. They are crucial for verifying identity, accessing services, traveling, and conducting legal or financial transactions. Personal documents are often required for various processes like applying for a job, opening bank accounts, or registering for healthcare.
Document type: personal-documents
| Label | Type | Slug |
|---|---|---|
| Document number | text | pd:document-number |
| Personal ID | text | pd:personal-number |
| Names | text | pd:names |
| Surnames | text | pd:surnames |
| Birthplace | text | pd:birthplace |
| Gender | text | pd:gender |
| Expiration date | date | pd:expiration-date |
Invoices
Invoices are commercial documents used to request payment for goods or services provided. They typically include details such as the sellerâs and buyerâs contact information, a description of the items or services, the total amount due, payment terms, and the invoice date. Invoices serve as a formal record of a transaction and are important for accounting, tax reporting, and tracking payments. They help ensure that both parties are clear on the terms and expectations of the sale.
Document type: invoices
| Label | Type | Slug |
|---|---|---|
| Billing address | text | iv:billing-address |
| Recipient billing address | text | iv:billing-address-recipient |
| Customer name | text | iv:customer-name |
| Customer tax ID | text | iv:customer-tax-id |
| Expiration date | date | iv:due-date |
| Invoice date | date | iv:invoice-date |
| Invoice ID | text | iv:invoice-id |
| Invoice total | text | iv:invoice-total |
| Shipping address | text | iv:shipping-address |
| Recipient shipping address | text | iv:shipping-address-recipient |
| Seller address | text | iv:seller-address |
| Seller Address Recipient | text | iv:seller-address-recipient |
| Seller name | text | iv:seller-name |
| Pending amount | text | iv:pending-amount |
| Client ID | text | iv:customer-id |
| Payment details | text | iv:payment-details |
| Remittance address | text | iv:remittance-address |
| Remittance address recipient | text | iv:remittance-address-recipient |
Receipts
Receipts are proof of payment or transaction, typically issued by a seller to a buyer. They include details such as the date of purchase, the items or services bought, the total amount paid, payment method, and any applicable taxes or discounts. Receipts serve as important records for both consumers and businesses, helping with returns, warranty claims, and accounting purposes. They confirm that a financial transaction has been completed and can be used for tracking expenses or verifying payment.
Document type: receipts
| Label | Type | Slug |
|---|---|---|
| Merchant Name | text | rc:merchant-name |
| Merchant Telephone Number | text | rc:merchant-phone-number |
| Merchant Address | text | rc:merchant-address |
| Transaction Date | date | rc:transaction-date |
| Transaction Time | time | rc:transaction-time |
| Subtotal | text | rc-subtotal |
| Tip | text | rc:tip |
| Total | text | rc:total |
| Total Tax | text | rc:total-tax |
| Tax Details | array | rc:tax-details |
| Articles | array | rc:items |
Credit Cards
Credit cards are financial tools issued by banks or financial institutions that allow individuals to borrow funds up to a certain credit limit to make purchases or withdraw cash. They typically include features such as a cardholderâs name, card number, expiration date, and a security code (CVV). Credit cards offer a revolving line of credit, which means the balance can be paid off over time, though interest is charged on outstanding balances. They are widely used for both online and in-store transactions and can also provide benefits such as rewards, cashback, and fraud protection.
Document type: credit-cards
| Label | Type | Slug |
|---|---|---|
| Card number | text | cc:card-number |
| Bank name | text | cc:bank-name |
| Payment processing network | text | cc:processing-network |
| Holder name | text | cc:holder-name |
| Holder company name | text | cc:company-holder-name |
| Valid from date | date | cc:valid-from-date |
| Expiration date | date | cc:expiration-date |
| CVV | text | cc:cvv |
| Support phone number | array | cc:phone-numbers |
Limitations
- PDF documents with passwords are not supported.
- URL path with security are not allowed.
- The model
personal_docscan validate all types of passports worldwide, as well as personal IDs and driverâs licenses from the United States, India, Europe, Australia, and Canada. For other countries, if the expected fields cannot be retrieved, please create a support ticket to request a custom model. Remember to provide document examples.