Meta-Data

API Documentation

Unlock insights from documents with machine learning.

Getting started

The Recognic APIs allows you to programmatically extract the document data. On this page, you will discover a prologue to the API use from an engineer viewpoint and a reference to all the API objects and methods. The APIs are totally RESTful and all the responses are returned in JSON.

API Authorization

The API requests need to be authenticated with a secret API_KEY linked to your account. You will have to supply the same as a query parameter while usage. Your API key carries many privileges, so be sure to keep them secret! All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
For more information on API key, contact care@recognic.ai.

API Gateways

Recognic permits you to process documents utilizing these APIs. You can transfer your document with an HTTP POST request, or by giving a public URL which can be utilized to bring the archive.

API Parameters

We offer a few alternatives to import a doc to recognic to make it simple and feasible for you to incorporate recognic into your current work process.

You will need to pass the image as multipart/form-data in an HTTP POST request (see sample requests in each category below). Your file input must adhere to the following criterias,

File type supported:Varies from document to document (inspect categories below for more details)

File type supported for extraction through URL: jpg/jpeg/png, pdf

Maximum file size:10Mb

Maximum zip file size:25Mb

India
KYC

Effective Endpoint

https://india.recognic.ai/bfsi/kyc/

More Details

Supported Documents & Formats

Document Front Back jpg/jpeg/png pdf tiff
Aadhaar
PAN
Driving license
Passport
Voter ID

Notes

  • Multiple KYC documents in a single file is supported, provided each KYC document is on a separate page.
  • Front & back images on the same page are supported as long as images belong to the same document type.
  • Cheques
    1. We Support only printed A/C numbers on cheques.
    2. Joint account holder names - Only single name is extracted.
    3. Try to avoid Xeroxed photocopy as the watermark might get mixed with the output result.
  • Passport
    1. Side-by Side image of the front and backside is not supported. One below the other works fine
  • DIGILOCKER - Documents exported from Digilocker are not supported yet.
  • Data extracted from the QR code may not be the same as it is visible on the document

Sample Request

curl
--include
--request POST
--url 'https://india.recognic.ai/bfsi/kyc/?API_KEY=<>'
--header 'Content-Type: multipart/form-data'
--form image=@<>
Financial Documents

Effective Endpoint

https://india.recognic.ai/bfsi/fin_docs/

More Details

Supported Documents & Formats

Document Single Page PDF Multi Page PDF jpg/jpeg/png pdf tiff
Cheque
ITR 1,2,3,4,4S
ITR Sahaj
Form 16
Bank Statement

Sample Request

curl
--include
--request POST
--url 'https://india.recognic.ai/bfsi/fin_docs/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
Lending

Effective Endpoint

https://india.recognic.ai/bfsi/lending_docs/

More Details

Supported Documents & Formats

Document jpg/jpeg/png tiff
Audit Reports

Sample Request

curl
--include
--request POST
--url 'https://india.recognic.ai/bfsi/lending_docs/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
SEA
KYC-SINGAPORE

Effective Endpoint

https://sea.recognic.ai/bfsi/identity_docs/

More Details

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Hong Kong Identity Number (HKID)
Hong Kong Passport
Singapore Passport

Sample Request

curl
--include
--request POST
--url 'https://sea.recognic.ai/bfsi/identity_docs/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
KYC-INDONESIA

Effective Endpoint

https://sea.recognic.ai/bfsi/ktpid/

More Details

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Indonesia ID (KTPID)

Sample Request

curl
--include
--request POST
--url 'https://sea.recognic.ai/bfsi/ktpid/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
USA
Bank Statements

Effective Endpoint

https://usa.recognic.ai/bfsi/bank_statement/

More Details

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Bank Of America
Capital One
Chase
WellsFargo
Citi

Sample Request

curl
--include
--request POST
--url 'https://usa.recognic.ai/bfsi/identity_docs/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
Credit Profile

Effective Endpoint

https://usa.recognic.ai/bfsi/credit_report/

More Details

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Credit Reports

Sample Request

curl
--include
--request POST
--url 'https://usa.recognic.ai/bfsi/credit_report/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
Taxation

Effective Endpoint

https://usa.recognic.ai/bfsi/w2_forms/

More Details

Refer on Swagger

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
V1
V2

Sample Request

curl
--include
--request POST
--url 'https://usa.recognic.ai/bfsi/w2_forms/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
Logistics

Effective Endpoint

https://usa.recognic.ai/logistics/invoice/

More Details

Refer on Swagger

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Commercial Invoice
Proforma Invoice

Sample Request

curl
--include
--request POST
--url 'https://usa.recognic.ai/logistics/invoice/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
Lending
Schedule E Form 1040

Effective Endpoint

usa.recognic.ai/lending/schedule_e_1040/
Closing disclosure

Effective Endpoint

usa.recognic.ai/lending/closing_disclosure/
SSA-1099

Effective Endpoint

usa.recognic.ai/lending/beta/ssa_1099/
W2

Effective Endpoint

usa.recognic.ai/lending/beta/w2_forms/
W9

Effective Endpoint

usa.recognic.ai/lending/beta/w9/
Tax Returns Page 1,2 Form 1040

Effective Endpoint

usa.recognic.ai/lending/beta/tax_form_1040/

More Details

Refer on Swagger

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Schedule E Form 1040
Closing disclosure
SSA-1099
W2
W9
Tax Returns Page 1,2 Form 1040

Sample Request

curl
--include
--request POST
--url 'https://usa.recognic.ai/lending/schedule_e_1040/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
Healthcare
Tumor Segmentation

Effective Endpoint

https://usa.recognic.ai/healthcare/tumor_segmentation/

More Details

Refer on Swagger

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Brain MRI

Sample Request

curl
--include
--request POST
--url 'https://usa.recognic.ai/healthcare/tumor_segmentation/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
UK
Identity Documents

Effective Endpoint

https://sea.recognic.ai/bfsi/uk_kyc/

More Details

Supported Documents & Formats

Document jpg/jpeg/png pdf tiff
Driving Licence
Passport

Sample Request

curl
--include
--request POST
--url 'https://uk.recognic.ai/bfsi/uk_kyc/?API_KEY={{YOUR_API_KEY}}'
--header 'Content-Type: multipart/form-data'
--form image=@{{YOUR_FILE_PATH}}
UAE
Arab Driving License
Common Guidelines

To get the most out of Recognic APIs make sure to adhere to these suggestions,

  • While capturing an image of a document please make sure the background is white / no overlapping text / plain background.
  • Avoid screenshots of documents.
  • PDFs should be primarily system generated. If PDFs contain scanned images they should be of reasonably good quality.
API Errors

Successful responses are returned with HTTP Status code 200. Failure returns a JSON error response with the parameters that detail the reason for the failure. The errors are classified in to following categories,

  1. Gateway errors
    Reason Status Status Code
    API Key Expired Unauthorized 401
    API Key Revoked Unauthorized 401
    Invalid Authentication Type             Unauthorized 401
    Invalid API Key Provided Unauthorized 401
    Spike Arrest Violation Too Many Requests 429
  2. Consumption errors
    Reason Status Status Code
    Input File Not Provided Unauthorized 400
    Bad Quality Document Provided Unauthorized 400
    Invalid Image Provided Unauthorized 400
    Internal Server Error Unauthorized 500

Try the demo

Upload a document (like an identity card, bank statement or forms) and see the structured data extracted.

Explore product